-
Notifications
You must be signed in to change notification settings - Fork 3
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Move Current Components to Experimental Section in Storybook #273
Conversation
…nfiguration and storybook documentation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would you also move the component implementations into a separate experimental directory as well to organize the code in the repo?
Please use the git mv
command where possible to make the PR easier to review.
The final directory structure should look like:
src
├── experimental
├── components
├── index-experimental.js
└── stories
├── stable
├── components
├── index-stable.js
└── stories
├── scss
└── shared
@sreidthomas you can also pull the latest dev branch (with #275 included) and merge it into this branch to fix the CI errors. |
|
@sreidthomas the new directory structure is causing some issues finding files during JS imports. You'll have to fix that to fix the new CI failures. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Moving the component implementation files is causing import errors that need to be fixed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good, nice work!
Move Current Components to Experimental Section in Storybook
This PR introduces an Experimental section in Storybook and moves all current components and form components under this section. Additionally, it updates build configurations and scripts to reflect these changes.
Key Updates
1. Create Experimental Section in Storybook
title
property in each story file for the components and form components to includeExperimental/
as a prefix."Components/Button"
to"Experimental/Components/Button"
."Forms/Input"
to"Experimental/Forms/Input"
.2. Update Documentation
Updated the documentation under the
COD UXDS
section to include the following details:Experimental Components
These components are unstable and should only be used for testing purposes. They:
3. Rename Component Index
src/index.js
src/index-experimental.js
.entry
point:./src/index.js
./src/index-experimental.js
.build/
build/experimental/
.npm run build
andyarn storybook
.4. Rename Build Script
package.json
file:"build": "webpack --mode production"
"build:experimental": "webpack --mode production"
.yarn build:experimental
.Testing
yarn storybook
to ensure the updated structure appears correctly in the Storybook sidebar.yarn build:experimental
to confirm the build output in the correct directory.Notes
title
field in the respective story files.