From e370712a5ad73f9d7a37598e84e6c8794041d739 Mon Sep 17 00:00:00 2001 From: Tom Coleman Date: Fri, 14 Aug 2020 14:25:22 +1000 Subject: [PATCH 1/2] Remove docs commands --- package.json | 5 +---- scripts/bootstrap.js | 11 +---------- 2 files changed, 2 insertions(+), 14 deletions(-) diff --git a/package.json b/package.json index 74ec3f63dab4..2d818db631de 100644 --- a/package.json +++ b/package.json @@ -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", @@ -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", @@ -302,4 +299,4 @@ ] ] } -} \ No newline at end of file +} diff --git a/scripts/bootstrap.js b/scripts/bootstrap.js index af24ca7268e8..e234eb9b4a23 100755 --- a/scripts/bootstrap.js +++ b/scripts/bootstrap.js @@ -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, @@ -150,7 +141,7 @@ function run() { }; const groups = { - main: ['core', 'docs'], + main: ['core'], buildtasks: ['install', 'build', 'dll', 'packs'], devtasks: ['dev', 'registry', 'reset'], }; From d3177a594ae45da9c409ea25a57ff8038fccdf4c Mon Sep 17 00:00:00 2001 From: Tom Coleman Date: Fri, 14 Aug 2020 14:25:32 +1000 Subject: [PATCH 2/2] Add note about how to run docs --- CONTRIBUTING.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4b85ab64f154..29e292f506d6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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: