Skip to content

Commit

Permalink
Update docs to reference the published Storybook
Browse files Browse the repository at this point in the history
- Update dev readme with link to published Storybook
- Update release doc to include steps for publishing the Storybook
  • Loading branch information
AlanGreene authored and tekton-robot committed Aug 24, 2023
1 parent c246d5c commit 7cc2ccf
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/dev/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,8 @@ Stories are defined in `*.stories.js(x)` files alongside their components.

Run `npm run storybook:build` to build the static storybook files. The build artifacts will be stored in the `static-storybook/` directory and can be hosted on GitHub Pages or any other static resource server.

**Note**: The Storybook for the latest published packages is available at https://tektoncd.github.io/dashboard/. For previous versions, checkout the relevant commit and run Storybook locally.

## Next steps

You can read the dashboard backend [API docs](./api.md).
Expand Down
4 changes: 4 additions & 0 deletions tekton/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,3 +148,7 @@ To release a new version of the npm packages, e.g. `@tektoncd/dashboard-componen
1. `npm --workspaces publish --otp <one-time-passcode>`
1. once the packages are published run `npm install`
1. stage and commit the changes to the package.json and package-lock.json files and open a new PR to record the release
1. build and publish the Storybook:
1. `npm run storybook:build`
1. `npm run storybook:deploy -- --remote upstream`
1. verify that the updated version is available at https://tektoncd.github.io/dashboard/

0 comments on commit 7cc2ccf

Please sign in to comment.