-
-
Notifications
You must be signed in to change notification settings - Fork 9.2k
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
Docs: Update documented Angular builder options #28562
base: next
Are you sure you want to change the base?
Docs: Update documented Angular builder options #28562
Conversation
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.
PR Summary
- Added new Angular builder options to
docs/get-started/frameworks/angular.mdx
- Updated configuration table in
docs/get-started/install.mdx
- Included links to Angular builder schemas in
docs/get-started/install.mdx
2 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings
☁️ Nx Cloud ReportCI is running/has finished running commands for commit 5f31dab. 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. |
Above the table on the framework page, it calls the table a list of common options. On the install page, it calls the table a list of supported options. Should this wording be changed to match? Neither is exactly correct. In my opinion, "common options" sort of depends on what the developer does. I could remove options, to try and make the lists smaller and just most likely common options. Saying the list is the "supported options" seems more like what should be in a documentation, but it isn't actually all supported options, unless we specify which builder each option applies to. |
@Marklb, sorry for the delayed response, but it's been some busy weeks here at Storybook. Regarding your points, I agree with your reasoning. As a middle ground, we should use supported options for now to implement them and establish baseline documentation that we can improve on. If you're okay with making that small adjustment, I'd appreciate it. And we can get this pull request in. One thing I was thinking was to extend the Angular framework API section to include the builder options, including some examples. With that in mind, we could also adjust the Troubleshooting guide for Angular and provide a link to the framework page's API section, effectively reducing the maintenance burden for the documentation by having a single source of truth for the builder and avoid scenarios as the one we're into. Looking forward to hearing from you. Have a great day |
Closes #
What I did
Multiple options have been added to the Angular builders, since the options were added to the docs. I updated the table for the install and framework pages to include the missing options for the start-storybook builder, since that seemed to be what the table was originally based on.
I also added the schema links below the table on the install page.
I don't want to make the options list too overwhelming, but should they list all options for both builders and specify which builders support the option. A table for both is also an option, but I don't know if that would be easier to read or overwhelming. Currently, these tables contain options that are not in the
build-storybook
builder and missing options that are not in thestart-storybook
builder.Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!
Just docs, so no tests.
Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal
,ci:merged
orci:daily
GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli/src/sandbox-templates.ts
Make 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/core
team 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>