chore(contextualhelp,datepicker,fieldgroup): remove MDX files #3422

marissahuysentruyt · 2024-11-26T17:26:38Z

Description

This PR migrates any documentation from MDX files to the component's *.stories.js file. No loss of documentation should have occurred, but minor changes, like correcting story names to organize similar stories together or reorganizing content now that there is not an MDX file or fixing sentence-casing, is acceptable.

Components included are:

contextual help (The missing help icon variant was added to the testing preview)
date picker (there was some missing documentation/guidance, so that was added. A new OpenClosedTemplate was already created to display both states side-by-side in stories on the docs page)
field group (there was some missing documentation/guidance, so that was added. Several new templates were created to showcase both inputs or required/optional variants together.)

Jira/Specs

CSS-1050

How and where has this been tested?

Please tag yourself on the tests you've marked complete to confirm the tests have been run by someone other than the author.

Validation steps

Pull down the branch to run locally or visit the deploy preview.
Visit the contextual help docs page. [@castastrophe]
Verify the information on the docs page matches the production docs page for contextual help. [@castastrophe]
Repeat the process for date picker (here's the PR link to compare to date picker's production) and field group (and this PR link to compare to field group's production)
Verify any new documentation makes sense and is accurate. [@castastrophe]
Verify there is no longer repeated "Usage notes" on the date picker docs page.

Visit the testing preview for contextual help to verify the help icon variant is rendering and captured. [@castastrophe]

Regression testing

Validate:

The documentation pages for at least two other components are still loading, including:

The pages render correctly, are accessible, and are responsive.

If components have been modified, VRTs have been run on this branch:

VRTs have been run and looked at.
Any VRT changes have been accepted (by reviewer and/or PR author), or there are no changes. (the contextual help and field group edits were expected changes in the VRT run against main!)

Screenshots

To-do list

I have read the contribution guidelines.
I have updated relevant storybook stories and templates.
If my change impacts documentation, I have updated the documentation accordingly.
✨ This pull request is ready to merge. ✨

changeset-bot · 2024-11-26T17:26:43Z

⚠️ No Changeset found

Latest commit: 408e10f

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

github-actions · 2024-11-26T17:28:17Z

🚀 Deployed on https://pr-3422--spectrum-css.netlify.app

github-actions · 2024-11-26T17:31:40Z

File metrics

Summary

Total size: 4.27 MB^*

🎉 No changes detected in any packages

* Size determined by adding together the size of the main file for all packages in the library.
* Results are not gzipped or minified.
* An ASCII character in UTF-8 is 8 bits or 1 byte.

castastrophe · 2024-12-03T22:04:17Z

@marissahuysentruyt What would you think of setting this against the s2-foundations-branch instead of main? I'm looking to merge in foundations soon so it would be a good place to capture this great update.

marissahuysentruyt · 2024-12-09T22:06:41Z

components/fieldgroup/stories/fieldgroup.test.js

@@ -19,11 +19,9 @@ export const FieldGroupSet = Variants({
 			testHeading: "Horizontal checkboxes",
 			layout: "horizontal",
 			inputType: "checkbox",
-			helpText: "Make a selection.",


These aren't really necessary changes. I was thinking that we don't really need to change the default values for any of the tests, so I removed them, but that does introduce changes in the VRTs (which I ran and accepted when this PR was pointed at main, but haven't run since pointing to s2-foundations-redux).

marissahuysentruyt · 2024-12-09T22:07:31Z

components/contextualhelp/stories/contextualhelp.test.js

+		{
+			testHeading: "Help",
+			iconName: "Help",
+			customStyles: {
+				"inline-size": "275px",
+				"margin-bottom": "170px",
+			},
+		},


I ran VRT against main originally to capture this test, but haven't run it against s2-foundations-redux yet.

- adds some additional documentation regarding stories/variants - migrates documentation in MDX to stories.js instead

- creates additional templates to showcase variants in a single story on the docs page - additional documentation to give context to stories - corrects sentence-casing in story names - removes duplicate control for label text - migrates documentation in MDX to stories.js instead

- fieldgroup: we don't really need to change the label text or help text between test cases, so some of the test-specific changes were removed - contextualhelp: add help icon test case

- adds missing date picker docs - migrates documentation in MDX to stories.js instead - creates OpenClosedTemplate to display both states in a single story on the docs page - adds Range variant to the sidebar since that control isn't in the table

* docs(contextualhelp): remove MDX file - adds some additional documentation regarding stories/variants - migrates documentation in MDX to stories.js instead * docs(fieldgroup): remove MDX file - creates additional templates to showcase variants in a single story on the docs page - additional documentation to give context to stories - corrects sentence-casing in story names - removes duplicate control for label text - migrates documentation in MDX to stories.js instead * chore(fieldgroup,contextualhelp): cleans up test files - fieldgroup: we don't really need to change the label text or help text between test cases, so some of the test-specific changes were removed - contextualhelp: add help icon test case * docs(datepicker): remove MDX file - adds missing date picker docs - migrates documentation in MDX to stories.js instead - creates OpenClosedTemplate to display both states in a single story on the docs page - adds Range variant to the sidebar since that control isn't in the table

marissahuysentruyt self-assigned this Nov 26, 2024

marissahuysentruyt added run_vrt For use on PRs looking to kick off VRT wip This is a work in progress, don't judge. skip_vrt Add to a PR to skip running VRT (but still pass the action) and removed run_vrt For use on PRs looking to kick off VRT labels Nov 26, 2024

marissahuysentruyt force-pushed the marissahuysentruyt/css-1050-refactor-contextualhelp-datepicker-fieldgroup-mdx branch 2 times, most recently from b3ef43e to 5ed41f2 Compare December 2, 2024 20:31

marissahuysentruyt changed the base branch from main to s2-foundations-redux December 5, 2024 15:04

marissahuysentruyt force-pushed the marissahuysentruyt/css-1050-refactor-contextualhelp-datepicker-fieldgroup-mdx branch from 5ed41f2 to 059bc8e Compare December 5, 2024 15:04

marissahuysentruyt removed the wip This is a work in progress, don't judge. label Dec 5, 2024

marissahuysentruyt marked this pull request as ready for review December 5, 2024 15:19

marissahuysentruyt removed the do not merge A flag for a branch indicating it should not be merged. label Dec 5, 2024

marissahuysentruyt commented Dec 9, 2024

View reviewed changes

castastrophe force-pushed the s2-foundations-redux branch from eb20c09 to 3d14fcc Compare December 11, 2024 00:17

marissahuysentruyt added 4 commits December 12, 2024 15:41

docs(contextualhelp): remove MDX file

2a77fbe

- adds some additional documentation regarding stories/variants - migrates documentation in MDX to stories.js instead

chore(fieldgroup,contextualhelp): cleans up test files

1bf0399

- fieldgroup: we don't really need to change the label text or help text between test cases, so some of the test-specific changes were removed - contextualhelp: add help icon test case

docs(datepicker): remove MDX file

408e10f

- adds missing date picker docs - migrates documentation in MDX to stories.js instead - creates OpenClosedTemplate to display both states in a single story on the docs page - adds Range variant to the sidebar since that control isn't in the table

marissahuysentruyt force-pushed the marissahuysentruyt/css-1050-refactor-contextualhelp-datepicker-fieldgroup-mdx branch from 059bc8e to 408e10f Compare December 12, 2024 20:41

marissahuysentruyt added the ready-for-review label Dec 12, 2024

castastrophe approved these changes Dec 16, 2024

View reviewed changes

castastrophe merged commit 55d0394 into s2-foundations-redux Dec 16, 2024
2 checks passed

castastrophe deleted the marissahuysentruyt/css-1050-refactor-contextualhelp-datepicker-fieldgroup-mdx branch December 16, 2024 19:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

chore(contextualhelp,datepicker,fieldgroup): remove MDX files #3422

chore(contextualhelp,datepicker,fieldgroup): remove MDX files #3422

Uh oh!

marissahuysentruyt commented Nov 26, 2024 •

edited by castastrophe

Loading

Uh oh!

changeset-bot bot commented Nov 26, 2024 •

edited

Loading

Uh oh!

github-actions bot commented Nov 26, 2024 •

edited

Loading

Uh oh!

github-actions bot commented Nov 26, 2024 •

edited

Loading

Uh oh!

castastrophe commented Dec 3, 2024

Uh oh!

marissahuysentruyt Dec 9, 2024

Uh oh!

marissahuysentruyt Dec 9, 2024

Uh oh!

Uh oh!

Uh oh!

chore(contextualhelp,datepicker,fieldgroup): remove MDX files #3422

chore(contextualhelp,datepicker,fieldgroup): remove MDX files #3422

Uh oh!

Conversation

marissahuysentruyt commented Nov 26, 2024 • edited by castastrophe Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Jira/Specs

How and where has this been tested?

Validation steps

Regression testing

Screenshots

To-do list

Uh oh!

changeset-bot bot commented Nov 26, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

github-actions bot commented Nov 26, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Nov 26, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

File metrics

Summary

Uh oh!

castastrophe commented Dec 3, 2024

Uh oh!

marissahuysentruyt Dec 9, 2024

Choose a reason for hiding this comment

Uh oh!

marissahuysentruyt Dec 9, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

marissahuysentruyt commented Nov 26, 2024 •

edited by castastrophe

Loading

changeset-bot bot commented Nov 26, 2024 •

edited

Loading

github-actions bot commented Nov 26, 2024 •

edited

Loading

github-actions bot commented Nov 26, 2024 •

edited

Loading