Update docs to 4.0

storybookjs · Oct 29, 2018 · 2d90f0d · 2d90f0d
1 parent 8dd9bb3
commit 2d90f0d
Show file tree

Hide file tree

Showing 20 changed files with 37 additions and 85 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,8 @@
 
 # 4.0.0
 
+2018-October-29
+
 Storybook 4.0 is our first major-version update in over a year! Key improvements include:
 
 -   Build tools
@@ -30,7 +32,7 @@ Storybook 4.0 is our first major-version update in over a year! Key improvements
     -   CLI-less Node api [#4344](https://github.com/storybooks/storybook/pull/4344)
     -   Rename CLI to sb [#4345](https://github.com/storybooks/storybook/pull/4345)
 
-There are hundreds of more fixes, features, and tweaks in the 4.0 release. See changelogs for `4.0.0-rc.*` and  `4.0.0-alpha.*` for details; check out our [migration docs](MIGRATION.md#from-version-34x-to-40x) for an enumeration of breaking changes.
+There are hundreds of more fixes, features, and tweaks in the 4.0 release. See changelogs for `4.0.0-rc.*` and  `4.0.0-alpha.*` for details; check out our [migration docs](https://github.com/storybooks/storybook/blob/master/MIGRATION.md#from-version-34x-to-40x) for an enumeration of breaking changes.
 
 # 4.0.0-rc.6
 

diff --git a/MIGRATION.md b/MIGRATION.md
@@ -179,7 +179,7 @@ If you're using `start-storybook` on CI, you may need to opt out of this using t
 We've deprecated the `getstorybook` CLI in 4.0. The new way to install storybook is `sb init`. We recommend using `npx` for convenience and to make sure you're always using the latest version of the CLI:
 
 ```
-npx -p @storybook/cli@rc sb init
+npx -p @storybook/cli sb init
 ```
 
 ### Addon story parameters

diff --git a/README.md b/README.md
@@ -55,7 +55,7 @@ First install storybook:
 
 ```sh
 cd my-react-app
-npx -p @storybook/cli@rc sb init
+npx -p @storybook/cli sb init
 ```
 
 If you'd rather set up your project manually, take a look at our [Slow Start Guide](https://storybook.js.org/basics/slow-start-guide/).
@@ -66,7 +66,7 @@ Once it's installed, you can `npm run storybook` and it will run the development
 
 ```sh
 cd my-storybook-v2-app
-npx -p @storybook/cli@rc sb init
+npx -p @storybook/cli sb init
 ```
 
 It runs a codemod to update all package names. Read all migration details in our [Migration Guide](MIGRATION.md)

diff --git a/app/angular/README.md b/app/angular/README.md
@@ -12,7 +12,7 @@ So you can develop UI components in isolation without worrying about app specifi
 
 ```sh
 cd my-angular-app
-npx -p @storybook/cli@rc sb init
+npx -p @storybook/cli sb init
 ```
 
 For more information visit: [storybook.js.org](https://storybook.js.org)

diff --git a/app/ember/README.md b/app/ember/README.md
@@ -12,7 +12,7 @@ So you can develop UI components in isolation without worrying about app specifi
 
 ```sh
 cd my-ember-app
-npx -p @storybook/cli@rc sb init
+npx -p @storybook/cli sb init
 ```
 
 For more information visit: [storybook.js.org](https://storybook.js.org)

diff --git a/app/html/README.md b/app/html/README.md
@@ -14,7 +14,7 @@ So you can develop UI components in isolation without worrying about app specifi
 
 ```sh
 cd my-app
-npx -p @storybook/cli@rc sb init -t html
+npx -p @storybook/cli sb init -t html
 ```
 
 For more information visit: [storybook.js.org](https://storybook.js.org)

diff --git a/app/marko/README.md b/app/marko/README.md
@@ -12,7 +12,7 @@ So you can develop UI components in isolation without worrying about app specifi
 
 ```sh
 cd my-marko-app
-npx -p @storybook/cli@rc sb init
+npx -p @storybook/cli sb init
 ```
 
 For more information visit: [storybook.js.org](https://storybook.js.org)

diff --git a/app/mithril/README.md b/app/mithril/README.md
@@ -12,7 +12,7 @@ So you can develop UI components in isolation without worrying about app specifi
 
 ```sh
 cd my-mithril-app
-npx -p @storybook/cli@rc sb init
+npx -p @storybook/cli sb init
 ```
 
 For more information visit: [storybook.js.org](https://storybook.js.org)

diff --git a/app/polymer/README.md b/app/polymer/README.md
@@ -14,7 +14,7 @@ So you can develop UI components in isolation without worrying about app specifi
 
 ```sh
 cd my-polymer-app
-npx -p @storybook/cli@rc sb init
+npx -p @storybook/cli sb init
 ```
 
 For more information visit: [storybook.js.org](https://storybook.js.org)

diff --git a/app/react-native/readme.md b/app/react-native/readme.md
@@ -12,7 +12,7 @@ The `storybook` CLI tool can be used to add Storybook to your React Native app.
 
 ```shell
 cd my-rn-app
-npx -p @storybook/cli@rc sb init
+npx -p @storybook/cli sb init
 ```
 
 The next thing you need to do is make Storybook UI visible in your app.

diff --git a/app/react/README.md b/app/react/README.md
@@ -12,7 +12,7 @@ So you can develop UI components in isolation without worrying about app specifi
 
 ```sh
 cd my-react-app
-npx -p @storybook/cli@rc sb init
+npx -p @storybook/cli sb init
 ```
 
 For more information visit: [storybook.js.org](https://storybook.js.org)

diff --git a/app/riot/README.md b/app/riot/README.md
@@ -14,7 +14,7 @@ So you can develop UI components in isolation without worrying about app specifi
 
 ```sh
 cd my-riot-app
-npx -p @storybook/cli@rc sb init
+npx -p @storybook/cli sb init
 ```
 
 For more information visit: [storybook.js.org](https://storybook.js.org)

diff --git a/app/svelte/README.md b/app/svelte/README.md
@@ -12,7 +12,7 @@ So you can develop UI components in isolation without worrying about app specifi
 
 ```sh
 cd my-svelte-app
-npx -p @storybook/cli@rc sb init
+npx -p @storybook/cli sb init
 ```
 
 For more information visit: [storybook.js.org](https://storybook.js.org)

diff --git a/app/vue/README.md b/app/vue/README.md
@@ -12,7 +12,7 @@ So you can develop UI components in isolation without worrying about app specifi
 
 ```sh
 cd my-vue-app
-npx -p @storybook/cli@rc sb init
+npx -p @storybook/cli sb init
 ```
 
 For more information visit: [storybook.js.org](https://storybook.js.org)

diff --git a/docs/src/components/Homepage/MainLinks/index.js b/docs/src/components/Homepage/MainLinks/index.js
@@ -24,11 +24,9 @@ class MainLinks extends React.Component {
             <h2>Try Now</h2>
             <pre>
               <code>
-                npm i -g @storybook/cli
+                cd my-react-vue-angular-app
                 <br />
-                cd my-react-app
-                <br />
-                getstorybook
+                npx -p @storybook/cli sb init
                 <br />
               </code>
             </pre>

diff --git a/docs/src/pages/basics/quick-start-guide/index.md b/docs/src/pages/basics/quick-start-guide/index.md
@@ -10,13 +10,13 @@ Get started using the automated command line tool. This command adds a set of bo
 
 ```sh
 cd my-project-directory
-npx -p @storybook/cli@rc sb init
+npx -p @storybook/cli sb init
 ```
 
 The tool inspects your `package.json` to determine which view layer you're using. If you want to develop HTML snippets in storybook, we can't determine that automatically. So to install storybook for HTML, use the `--type` flag to force that the HTML project type:
 
 ```
-npx -p @storybook/cli@rc sb init --type html
+npx -p @storybook/cli sb init --type html
 ```
 
 To setup a project manually, take a look at the [Slow Start Guide](/basics/slow-start-guide/).

diff --git a/docs/yarn.lock b/docs/yarn.lock
@@ -796,13 +796,6 @@ async-limiter@~1.0.0:
   resolved "https://registry.yarnpkg.com/async-limiter/-/async-limiter-1.0.0.tgz#78faed8c3d074ab81f22b4e985d79e8738f720f8"
   integrity sha512-jp/uFnooOiO+L211eZOoSyzpOITMXx1rBITauYykG3BRYPu8h0UcxsPNB04RR5vo4Tyz3+ay17tR6JVf9qzYWg==
 
-async@2.6.1, async@^2.1.2, async@^2.1.4:
-  version "2.6.1"
-  resolved "https://registry.yarnpkg.com/async/-/async-2.6.1.tgz#b245a23ca71930044ec53fa46aa00a3e87c6a610"
-  integrity sha512-fNEiL2+AZt6AlAw/29Cr0UDe4sRAHCpEHh54WMz+Bb7QfNcFw4h3loofyJpLeQs4Yx7yuqu/2dLgM5hKOs6HlQ==
-  dependencies:
-    lodash "^4.17.10"
-
 async@^0.9.0:
   version "0.9.2"
   resolved "https://registry.yarnpkg.com/async/-/async-0.9.2.tgz#aea74d5e61c1f899613bf64bda66d4c78f2fd17d"
@@ -813,6 +806,13 @@ async@^1.3.0, async@^1.4.0, async@^1.5.0, async@~1.5:
   resolved "https://registry.yarnpkg.com/async/-/async-1.5.2.tgz#ec6a61ae56480c0c3cb241c95618e20892f9672a"
   integrity sha1-7GphrlZIDAw8skHJVhjiCJL5Zyo=
 
+async@^2.1.2, async@^2.1.4:
+  version "2.6.1"
+  resolved "https://registry.yarnpkg.com/async/-/async-2.6.1.tgz#b245a23ca71930044ec53fa46aa00a3e87c6a610"
+  integrity sha512-fNEiL2+AZt6AlAw/29Cr0UDe4sRAHCpEHh54WMz+Bb7QfNcFw4h3loofyJpLeQs4Yx7yuqu/2dLgM5hKOs6HlQ==
+  dependencies:
+    lodash "^4.17.10"
+
 async@~0.2.6:
   version "0.2.10"
   resolved "https://registry.yarnpkg.com/async/-/async-0.2.10.tgz#b6bbe0b0674b9d719708ca38de8c237cb526c3d1"
@@ -3082,11 +3082,6 @@ command-exists@^1.2.2:
   resolved "https://registry.yarnpkg.com/command-exists/-/command-exists-1.2.8.tgz#715acefdd1223b9c9b37110a149c6392c2852291"
   integrity sha512-PM54PkseWbiiD/mMsbvW351/u+dafwTJ0ye2qB60G1aGQP9j3xK2gmMDc+R34L3nDtx4qMCitXT75mkbkGJDLw==
 
-commander@2.15.1:
-  version "2.15.1"
-  resolved "https://registry.yarnpkg.com/commander/-/commander-2.15.1.tgz#df46e867d0fc2aec66a34662b406a9ccafff5b0f"
-  integrity sha512-VlfT9F3V0v+jr4yxPc5gg9s62/fIVWsd2Bk2iD435um1NlGMYdVCq+MjcXnhYq2icNOizHr1kK+5TI6H0Hy0ag==
-
 commander@2.17.x, commander@~2.17.1:
   version "2.17.1"
   resolved "https://registry.yarnpkg.com/commander/-/commander-2.17.1.tgz#bd77ab7de6de94205ceacc72f1716d29f20a77bf"
@@ -5088,15 +5083,7 @@ filename-reserved-regex@^2.0.0:
   resolved "https://registry.yarnpkg.com/filename-reserved-regex/-/filename-reserved-regex-2.0.0.tgz#abf73dfab735d045440abfea2d91f389ebbfa229"
   integrity sha1-q/c9+rc10EVECr/qLZHzieu/oik=
 
-filenamify-url@^1.0.0:
-  version "1.0.0"
-  resolved "https://registry.yarnpkg.com/filenamify-url/-/filenamify-url-1.0.0.tgz#b32bd81319ef5863b73078bed50f46a4f7975f50"
-  integrity sha1-syvYExnvWGO3MHi+1Q9GpPeXX1A=
-  dependencies:
-    filenamify "^1.0.0"
-    humanize-url "^1.0.0"
-
-filenamify@^1.0.0, filenamify@^1.0.1:
+filenamify@^1.0.1:
   version "1.2.1"
   resolved "https://registry.yarnpkg.com/filenamify/-/filenamify-1.2.1.tgz#a9f2ffd11c503bed300015029272378f1f1365a5"
   integrity sha1-qfL/0RxQO+0wABUCknI3jx8TZaU=
@@ -5387,15 +5374,6 @@ fs-extra@^4.0.1:
     jsonfile "^4.0.0"
     universalify "^0.1.0"
 
-fs-extra@^5.0.0:
-  version "5.0.0"
-  resolved "https://registry.yarnpkg.com/fs-extra/-/fs-extra-5.0.0.tgz#414d0110cdd06705734d055652c5411260c31abd"
-  integrity sha512-66Pm4RYbjzdyeuqudYqhFiNBbCIuI9kgRqLPSHIlXHidW8NIQtVdkM1yeZ4lXwuhbTETv3EUGMNHAAw6hiundQ==
-  dependencies:
-    graceful-fs "^4.1.2"
-    jsonfile "^4.0.0"
-    universalify "^0.1.0"
-
 fs-minipass@^1.2.5:
   version "1.2.5"
   resolved "https://registry.yarnpkg.com/fs-minipass/-/fs-minipass-1.2.5.tgz#06c277218454ec288df77ada54a03b8702aacb9d"
@@ -5881,19 +5859,6 @@ getpass@^0.1.1:
   dependencies:
     assert-plus "^1.0.0"
 
-gh-pages@^1.2.0:
-  version "1.2.0"
-  resolved "https://registry.yarnpkg.com/gh-pages/-/gh-pages-1.2.0.tgz#1acb92801078f7c038a167f447221d1496ccfbee"
-  integrity sha512-cGLYAvxtlQ1iTwAS4g7FreZPXoE/g62Fsxln2mmR19mgs4zZI+XJ+wVVUhBFCF/0+Nmvbq+abyTWue1m1BSnmg==
-  dependencies:
-    async "2.6.1"
-    commander "2.15.1"
-    filenamify-url "^1.0.0"
-    fs-extra "^5.0.0"
-    globby "^6.1.0"
-    graceful-fs "4.1.11"
-    rimraf "^2.6.2"
-
 github-from-package@0.0.0:
   version "0.0.0"
   resolved "https://registry.yarnpkg.com/github-from-package/-/github-from-package-0.0.0.tgz#97fb5d96bfde8973313f20e8288ef9a167fa64ce"
@@ -6168,7 +6133,7 @@ got@^7.0.0, got@^7.1.0:
     url-parse-lax "^1.0.0"
     url-to-options "^1.0.1"
 
-graceful-fs@4.1.11, graceful-fs@^4.0.0, graceful-fs@^4.1.10, graceful-fs@^4.1.11, graceful-fs@^4.1.2, graceful-fs@^4.1.3, graceful-fs@^4.1.4, graceful-fs@^4.1.6:
+graceful-fs@^4.0.0, graceful-fs@^4.1.10, graceful-fs@^4.1.11, graceful-fs@^4.1.2, graceful-fs@^4.1.3, graceful-fs@^4.1.4, graceful-fs@^4.1.6:
   version "4.1.11"
   resolved "https://registry.yarnpkg.com/graceful-fs/-/graceful-fs-4.1.11.tgz#0e8bdfe4d1ddb8854d64e04ea7c00e2a026e5658"
   integrity sha1-Dovf5NHduIVNZOBOp8AOKgJuVlg=
@@ -6739,14 +6704,6 @@ https-proxy-agent@^2.2.1:
     agent-base "^4.1.0"
     debug "^3.1.0"
 
-humanize-url@^1.0.0:
-  version "1.0.1"
-  resolved "https://registry.yarnpkg.com/humanize-url/-/humanize-url-1.0.1.tgz#f4ab99e0d288174ca4e1e50407c55fbae464efff"
-  integrity sha1-9KuZ4NKIF0yk4eUEB8VfuuRk7/8=
-  dependencies:
-    normalize-url "^1.0.0"
-    strip-url-auth "^1.0.0"
-
 hyphenate-style-name@^1.0.1, hyphenate-style-name@^1.0.2:
   version "1.0.2"
   resolved "https://registry.yarnpkg.com/hyphenate-style-name/-/hyphenate-style-name-1.0.2.tgz#31160a36930adaf1fc04c6074f7eb41465d4ec4b"
@@ -9197,7 +9154,7 @@ normalize-range@^0.1.2:
   resolved "https://registry.yarnpkg.com/normalize-range/-/normalize-range-0.1.2.tgz#2d10c06bdfd312ea9777695a4d28439456b75942"
   integrity sha1-LRDAa9/TEuqXd2laTShDlFa3WUI=
 
-normalize-url@^1.0.0, normalize-url@^1.4.0:
+normalize-url@^1.4.0:
   version "1.9.1"
   resolved "https://registry.yarnpkg.com/normalize-url/-/normalize-url-1.9.1.tgz#2cc0d66b31ea23036458436e3620d85954c66c3c"
   integrity sha1-LMDWazHqIwNkWENuNiDYWVTGbDw=
@@ -13341,11 +13298,6 @@ strip-outer@^1.0.0:
   dependencies:
     escape-string-regexp "^1.0.2"
 
-strip-url-auth@^1.0.0:
-  version "1.0.1"
-  resolved "https://registry.yarnpkg.com/strip-url-auth/-/strip-url-auth-1.0.1.tgz#22b0fa3a41385b33be3f331551bbb837fa0cd7ae"
-  integrity sha1-IrD6OkE4WzO+PzMVUbu4N/oM164=
-
 style-loader@^0.13.0:
   version "0.13.2"
   resolved "https://registry.yarnpkg.com/style-loader/-/style-loader-0.13.2.tgz#74533384cf698c7104c7951150b49717adc2f3bb"

diff --git a/lib/cli/README.md b/lib/cli/README.md
@@ -10,7 +10,7 @@ Just go to your project and run:
 
 ```sh
 cd my-app
-npx -p @storybook/cli@rc sb init
+npx -p @storybook/cli sb init
 ```
 
 That's all you've to do.
@@ -24,7 +24,7 @@ The CLI supports yarn. If you have installed yarn in your system, it'll detect i
 If you don't want to use `yarn` always you can use the `--use-npm` option like this:
 
 ```sh
-npx -p @storybook/cli@rc sb init --use-npm
+npx -p @storybook/cli sb init --use-npm
 ```
 
 ---
@@ -34,7 +34,7 @@ npx -p @storybook/cli@rc sb init --use-npm
 It also supports flow files. By default, [jscodeshift](https://github.com/facebook/jscodeshift), the tool used to transform the source files, uses babel to read the files. To be able to transform any flow annotated file, you need to use the flow parser.
 
 ```sh
-npx -p @storybook/cli@rc sb init --parser flow
+npx -p @storybook/cli sb init --parser flow
 ```
 
 For more information visit: [storybook.js.org](https://storybook.js.org)
@@ -46,7 +46,7 @@ For more information visit: [storybook.js.org](https://storybook.js.org)
 If the CLI cannot detect your project type, it will ask you. You can also force it to use a particular project type:
 
 ```sh
-npx -p @storybook/cli@rc sb init --type <type>
+npx -p @storybook/cli sb init --type <type>
 ```
 
 Where type is one of the project types defined in [project_types.js](https://github.com/storybooks/storybook/blob/master/lib/cli/lib/project_types.js)
diff --git a/lib/cli/test/fixtures/react_scripts/README.md b/lib/cli/test/fixtures/react_scripts/README.md
@@ -1509,7 +1509,7 @@ Then, run the following command inside your app’s directory:
 
 ```sh
 cd my-react-app
-npx -p @storybook/cli@rc sb init
+npx -p @storybook/cli sb init
 ```
 
 After that, follow the instructions on the screen.

diff --git a/lib/cli/test/fixtures/update_package_organisations/README.md b/lib/cli/test/fixtures/update_package_organisations/README.md
@@ -1178,7 +1178,7 @@ You can also deploy your Storybook as a static app. This way, everyone in your t
 Then, run the following command inside your app’s directory:
 
 ```sh
-npx -p @storybook/cli@rc sb init
+npx -p @storybook/cli sb init
 ```
 
 After that, follow the instructions on the screen.