Skip to content

Commit

Permalink
make suggested changes from PR
Browse files Browse the repository at this point in the history
  • Loading branch information
ahayes91 committed Jul 24, 2024
1 parent 23c0eb8 commit f2b5884
Show file tree
Hide file tree
Showing 8 changed files with 16 additions and 14 deletions.
6 changes: 3 additions & 3 deletions docs/_snippets/build-storybook-production-mode.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@ ng run my-project:build-storybook
```

```shell renderer="common" language="js" packageManager="npm"
npm run storybook build
npm run build-storybook
```

```shell renderer="common" language="js" packageManager="pnpm"
pnpm run storybook build
pnpm run build-storybook
```

```shell renderer="common" language="js" packageManager="yarn"
yarn storybook build
yarn build-storybook
```

2 changes: 1 addition & 1 deletion docs/_snippets/ghp-github-action.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ jobs:
- uses: bitovi/[email protected]
with:
install_command: yarn install # default: npm ci
build_command: yarn storybook build # default: npm run storybook build
build_command: yarn build-storybook # default: npm run build-storybook
path: storybook-static # default: dist/storybook
checkout: false # default: true
```
Expand Down
6 changes: 3 additions & 3 deletions docs/_snippets/storybook-build-test-flag.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
```shell renderer="common" language="js" packageManager="npm"
npm run storybook build -- --test
npm run build-storybook -- --test
```

```shell renderer="common" language="js" packageManager="pnpm"
pnpm run storybook build --test
pnpm run build-storybook --test
```

```shell renderer="common" language="js" packageManager="yarn"
yarn storybook build --test
yarn build-storybook --test
```

4 changes: 2 additions & 2 deletions docs/_snippets/storybook-debug-webpack-prod.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
```shell renderer="common" language="js" packageManager="npm"
npm run storybook build -- --debug-webpack
npm run build-storybook -- --debug-webpack
```

```shell renderer="common" language="js" packageManager="yarn"
yarn storybook build --debug-webpack
yarn build-storybook --debug-webpack
```

2 changes: 1 addition & 1 deletion docs/_snippets/test-runner-local-build-workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ jobs:
- name: Install Playwright
run: npx playwright install --with-deps
- name: Build Storybook
run: yarn storybook build --quiet
run: yarn build-storybook --quiet
- name: Serve Storybook and run tests
run: |
npx concurrently -k -s first -n "SB,TEST" -c "magenta,blue" \
Expand Down
6 changes: 4 additions & 2 deletions docs/api/main-config/main-config-build.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,12 @@ Type: `TestBuildFlags`
}
```

Configures Storybook's production builds for performance testing purposes by disabling certain features from the build. When running `storybook build`, this feature is enabled by setting the `--test` [flag](../cli-options.mdx#build).
Configures Storybook's production builds for performance testing purposes by disabling certain features from the build. When running `build-storybook`, this feature is enabled by setting the `--test` [flag](../cli-options.mdx#build).

<Callout variant="info" icon="💡">
The options documented on this page are automatically enabled when the `--test` flag is provided to the `storybook build` command. We encourage you to override these options only if you need to disable a specific feature for your project or if you are debugging a build issue.

The options documented on this page are automatically enabled when the `--test` flag is provided to the [`storybook build`](../cli-options.mdx#build) command. We encourage you to override these options only if you need to disable a specific feature for your project or if you are debugging a build issue.

</Callout>

### `test.disableBlocks`
Expand Down
2 changes: 1 addition & 1 deletion docs/configure/environment-variables.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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 `storybook build`.
You can also pass these environment variables when you are [building your Storybook](../sharing/publish-storybook.mdx) with `build-storybook`.

Then they'll be hardcoded to the static version of your Storybook.

Expand Down
2 changes: 1 addition & 1 deletion docs/writing-docs/build-documentation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ There's some caveats to this build mode, as to the normal Storybook build:

## Publish Storybook's documentation

You can also publish your documentation, the same you would [publish](../sharing/publish-storybook.mdx) your Storybook. You can use the `--docs` flag with `storybook build` command. We recommend as well including it as a script in your `package.json` file:
You can also publish your documentation the same you would [publish](../sharing/publish-storybook.mdx) your Storybook. You can use the `--docs` flag with the [`storybook build`](../api/cli-options.mdx#build) command. We recommend as well including it as a script in your `package.json` file:

```json
{
Expand Down

0 comments on commit f2b5884

Please sign in to comment.