Skip to content
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(storybook): use ESM for Storybook configs #18380

Merged
merged 1 commit into from
Aug 1, 2023

Conversation

benmccann
Copy link
Contributor

Current Behavior

The docs currently show CJS for the Storybook configs

Expected Behavior

When you run npx sb init to add Storybook to your project, it creates ESM configs by default. Since users will have ESM config we should use ESM in the docs. Another reason to use ESM is that it is built into the language and more future looking as opposed to the legacy CJS format

Related Issue(s)

N/A

@benmccann benmccann requested review from a team as code owners July 30, 2023 01:31
@vercel
Copy link

vercel bot commented Jul 30, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
nx-dev ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 1, 2023 10:40am

@mandarini
Copy link
Member

mandarini commented Aug 1, 2023

@benmccann thanks for the contribution. :D

Your commit had a small issue, but I made the fixes myself to expedite the process.

In your original commit you had made the changes to:

docs/generated/packages/storybook/documents/custom-builder-configs.md

instead of

docs/shared/packages/storybook/custom-builder-configs.md

Please take a look at our "contributing to docs" section. The changes need to be made in the .md file that is under docs/shared and then you need to run pnpm documentation so that it generates the file again. Don't worry, I understand that it may not be that straightforward, I'm just pointing you to the right direction, for your next contribution to our docs! :D :D :D

Thanks again!

@mandarini mandarini enabled auto-merge (squash) August 1, 2023 10:44
@mandarini mandarini disabled auto-merge August 1, 2023 10:44
@mandarini mandarini changed the title docs: use ESM for Storybook configs docs(storybook): use ESM for Storybook configs Aug 1, 2023
@mandarini mandarini enabled auto-merge (squash) August 1, 2023 10:45
@mandarini mandarini merged commit fd6bccd into nrwl:master Aug 1, 2023
14 of 15 checks passed
@github-actions
Copy link

github-actions bot commented Aug 7, 2023

This pull request has already been merged/closed. If you experience issues related to these changes, please open a new issue referencing this pull request.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 7, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants