Docs: Update build Storybook references #28271
Conversation
jonniebigodes
added
ci: do not merge
documentation
ci:docs
There was a problem hiding this comment.
@ahayes91 thank you so much for putting together this pull request and helping us improve our documentation by updating the contents and examples we provide. We appreciate it 🙏 ! Left some items for you to look into when you have a moment.
Let me know of any questions you may have regarding it so that I'm able to follow up with you on them.
Looking forward to hearing from you.
Hope you have a fantastic day.
Stay safe
| @@ -72,7 +72,7 @@ Then you can access this environment variable anywhere, even within your stories | |||
| You can also use specific files for specific modes. Add a `.env.development` or `.env.production` to apply different values to your environment variables. | |||
| </Callout> | |||
|
|
|||
| You can also pass these environment variables when you are [building your Storybook](../sharing/publish-storybook.mdx) with `build-storybook`. | |||
| You can also pass these environment variables when you are [building your Storybook](../sharing/publish-storybook.mdx) with `storybook build`. | |||
There was a problem hiding this comment.
Same goes here. In this context we're aiming for the script as well
There was a problem hiding this comment.
This is actually the page and the line that confused me as a passive Storybook user, and kicked off opening this whole PR 😂
I will make all the changes you have suggested, but maybe there is another improvement that we can make that can be explicit about when build-storybook is available and when it isn't, because reading the migration guide makes it seem like it is not available anymore https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#start-storybook--build-storybook-binaries-removed
There was a problem hiding this comment.
Thanks for pointing that out. We can improve that portion of the documentation to avoid any confusion you or any other Storybook user may have.
☁️ Nx Cloud ReportCI is running/has finished running commands for commit f2b5884. As they complete they will appear below. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this CI Pipeline Execution ✅ Successfully ran 1 targetSent with 💌 from NxCloud. |
jonniebigodes
changed the title
build-storybook command in the docs to storybook build
|
Thank you @jonniebigodes for reviewing! I must admit I forgot about this PR 😅 |
|
@ahayes91, thanks for addressing the feedback so promptly. I appreciate it 🙏 ! And don't worry about it. It's been some busy weeks here at Storybook, and I was also unable to do a review of this pull request. All is good on my end. I'm going to merge this once the checklist clears. Hope you have an amazing day. Stay safe |
What I did
I noticed some documentation today (specifically this page) still refers to the
build-storybookcommand, which was removed in v7 (https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#start-storybook--build-storybook-binaries-removed) in this PR.This confused me for a bit, so let's fix that 😏
I figured I may as well submit a PR updating a bunch of those places and maybe some more that seemed reasonable, but feel free to suggest changes I should remove for any reason!
start-storybookdoesn't seem to be mentioned as much in the docs anymore from what I can tell 💪Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
N/A
Manual testing
This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!
N/A unless anyone has suggestions otherwise
Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal,ci:mergedorci:dailyGH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli/src/sandbox-templates.tsMake sure this PR contains one of the labels below:
Available labels
bug: Internal changes that fixes incorrect behavior.maintenance: User-facing maintenance tasks.dependencies: Upgrading (sometimes downgrading) dependencies.build: Internal-facing build tooling & test updates. Will not show up in release changelog.cleanup: Minor cleanup style change. Will not show up in release changelog.documentation: Documentation only changes. Will not show up in release changelog.feature request: Introducing a new feature.BREAKING CHANGE: Changes that break compatibility in some way with current major version.other: Changes that don't fit in the above categories.🦋 Canary release
This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the
@storybookjs/coreteam here.core team members can create a canary release here or locally with
gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>