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.

Sign up for GitHub

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

Jump to bottom

Build: Remove documentation scripts and fix README #12015

Merged
merged 2 commits into from
Aug 14, 2020
Merged

Build: Remove documentation scripts and fix README #12015

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e370712
Remove docs commands
tmeasday Aug 14, 2020
d3177a5
Add note about how to run docs
tmeasday Aug 14, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 6 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -362,6 +362,12 @@ Save and go to `http://localhost:9011` (or wherever storybook is running)

If you don't see the changes rerun `yarn storybook` again in your sandbox app

### Documentation

The documentation for Storybook is served by the [frontpage](https://github.com/storybookjs/frontpage), but the docs files are in this repository.

To see changes in a development version of the docs, use the "linking" method documented [here](https://github.com/storybookjs/frontpage#docs-content).

## Release Guide

This section is for Storybook maintainers who will be creating releases. It assumes:
Expand Down
5 changes: 1 addition & 4 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,6 @@
"scripts": {
"await-serve-storybooks": "wait-on http://localhost:8001",
"bootstrap": "node ./scripts/bootstrap.js",
"bootstrap:docs": "yarn install --cwd docs",
"build": "node ./scripts/build-package.js",
"build-packs": "lerna exec --scope '@storybook/*' -- \\$LERNA_ROOT_PATH/scripts/build-pack.sh \\$LERNA_ROOT_PATH/packs",
"build-storybooks": "cross-env STORYBOOK_DISPLAY_WARNING=true DISPLAY_WARNING=true node -r esm ./scripts/build-storybooks.js",
Expand All @@ -58,8 +57,6 @@
"dev:babel": "lerna exec --scope @storybook/* --parallel -- cross-env-shell node \\$LERNA_ROOT_PATH/scripts/utils/watch-babel.js",
"dev:check-types": "tsc --noEmit",
"dev:tsc": "lerna exec --scope @storybook/* --parallel -- cross-env-shell node \\$LERNA_ROOT_PATH/scripts/utils/watch-tsc.js",
"docs:build": "npm --prefix docs run build",
"docs:dev": "npm --prefix docs run dev",
"github-release": "github-release-from-changelog",
"lint": "yarn lint:js . && yarn lint:md .",
"lint:js": "cross-env NODE_ENV=production eslint --cache --cache-location=.cache/eslint --ext .js,.jsx,.json,.html,.ts,.tsx,.mjs --report-unused-disable-directives",
Expand Down Expand Up @@ -302,4 +299,4 @@
]
]
}
}
}
11 changes: 1 addition & 10 deletions scripts/bootstrap.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,15 +110,6 @@ function run() {
},
order: 3,
}),
docs: createTask({
name: `Documentation ${chalk.gray('(docs)')}`,
defaultValue: false,
option: '--docs',
command: () => {
spawn('yarn bootstrap:docs');
},
order: 6,
}),
packs: createTask({
name: `Build tarballs of packages ${chalk.gray('(build-packs)')}`,
defaultValue: false,
Expand Down Expand Up @@ -150,7 +141,7 @@ function run() {
};

const groups = {
main: ['core', 'docs'],
main: ['core'],
buildtasks: ['install', 'build', 'dll', 'packs'],
devtasks: ['dev', 'registry', 'reset'],
};
Expand Down