From f87579f7eea0043cc5d460fc5f5886fd865b1ae6 Mon Sep 17 00:00:00 2001 From: Fernando Daciuk Date: Mon, 31 Oct 2016 03:21:28 -0200 Subject: [PATCH] Fix docs urls (#50) --- src/docs/react-storybook/addons/api.js | 2 +- src/docs/react-storybook/addons/introduction.js | 6 +++--- src/docs/react-storybook/addons/using-addons.js | 2 +- src/docs/react-storybook/addons/writing-addons.js | 6 +++--- src/docs/react-storybook/basics/introduction.js | 2 +- src/docs/react-storybook/basics/quick-start-guide.js | 2 +- src/docs/react-storybook/basics/writing-stories.js | 2 +- .../configurations/custom-webpack-config.js | 4 ++-- src/docs/react-storybook/configurations/env-vars.js | 2 +- .../configurations/serving-static-files.js | 2 +- src/docs/react-storybook/testing/css-style-testing.js | 2 +- src/docs/react-storybook/testing/react-ui-testing.js | 8 ++++---- .../storybook-hub/management-features/env-variables.js | 2 +- 13 files changed, 21 insertions(+), 21 deletions(-) diff --git a/src/docs/react-storybook/addons/api.js b/src/docs/react-storybook/addons/api.js index e14bb8b76c89..280d646b0540 100644 --- a/src/docs/react-storybook/addons/api.js +++ b/src/docs/react-storybook/addons/api.js @@ -32,7 +32,7 @@ export default { }); ~~~ - Now you'll get an instance to our StorybookAPI. See the [api docs](/docs/addons/api#storybook-api) for Storybook API regarding using that. + Now you'll get an instance to our StorybookAPI. See the [api docs](/docs/react-storybook/addons/api#storybook-api) for Storybook API regarding using that. ### addonAPI.addPanel() diff --git a/src/docs/react-storybook/addons/introduction.js b/src/docs/react-storybook/addons/introduction.js index 0255428f35c6..f5156712d497 100644 --- a/src/docs/react-storybook/addons/introduction.js +++ b/src/docs/react-storybook/addons/introduction.js @@ -104,8 +104,8 @@ export default { See the following links to learn more about native addons: - * [Using addons](/docs/addons/using-addons) - * [Addon gallery](/docs/addons/addon-gallery) - * [Write your own addon](/docs/addons/writing-addons) + * [Using addons](/docs/react-storybook/addons/using-addons) + * [Addon gallery](/docs/react-storybook/addons/addon-gallery) + * [Write your own addon](/docs/react-storybook/addons/writing-addons) ` }; diff --git a/src/docs/react-storybook/addons/using-addons.js b/src/docs/react-storybook/addons/using-addons.js index 9d6cd40cefda..ca5f03f889cd 100644 --- a/src/docs/react-storybook/addons/using-addons.js +++ b/src/docs/react-storybook/addons/using-addons.js @@ -62,7 +62,7 @@ export default { ![Stories with notes](${images.storiesWithNotes}) - Just like this, you can install any other addon and use it. Have a look at our [addon gallery](/docs/addons/addon-gallery) to discover more addons. + Just like this, you can install any other addon and use it. Have a look at our [addon gallery](/docs/react-storybook/addons/addon-gallery) to discover more addons. > This particular addon has created a panel in Storybook. Some addons may not create a panel and may use some other Storybook platform features. > diff --git a/src/docs/react-storybook/addons/writing-addons.js b/src/docs/react-storybook/addons/writing-addons.js index b7b407e04fc0..6305b7d45a4c 100644 --- a/src/docs/react-storybook/addons/writing-addons.js +++ b/src/docs/react-storybook/addons/writing-addons.js @@ -34,7 +34,7 @@ export default { * Select a story. * Register keyboard shortcuts (coming soon). - With this, you can write some pretty cool addons. Look at our [Addon gallery](/docs/addons/addon-gallery) to have a look at some sample addons. + With this, you can write some pretty cool addons. Look at our [Addon gallery](/docs/react-storybook/addons/addon-gallery) to have a look at some sample addons. ## Getting Started @@ -158,8 +158,8 @@ export default { ## Addon API - Here we've only used a few functionalities of our [Addon API](/docs/addons/api). - You can learn more about the complete API [here](/docs/addons/api). + Here we've only used a few functionalities of our [Addon API](/docs/react-storybook/addons/api). + You can learn more about the complete API [here](/docs/react-storybook/addons/api). ## Packaging diff --git a/src/docs/react-storybook/basics/introduction.js b/src/docs/react-storybook/basics/introduction.js index ca72055319dd..0b82677ba4f7 100644 --- a/src/docs/react-storybook/basics/introduction.js +++ b/src/docs/react-storybook/basics/introduction.js @@ -14,7 +14,7 @@ export default { ![React Storybook](${images.screenshot}) - React Storybook also comes with a lot of [addons](/docs/addons/introduction) and a great API to customize as you wish. You can also build a [static version](/docs/basics/exporting-storybook) of your storybook and deploy it anywhere you want. + React Storybook also comes with a lot of [addons](/docs/react-storybook/addons/introduction) and a great API to customize as you wish. You can also build a [static version](/docs/react-storybook/basics/exporting-storybook) of your storybook and deploy it anywhere you want. Here are some featured storybooks that you can reference to see how Storybook works: diff --git a/src/docs/react-storybook/basics/quick-start-guide.js b/src/docs/react-storybook/basics/quick-start-guide.js index a138a23410a8..7a84e188f2c8 100644 --- a/src/docs/react-storybook/basics/quick-start-guide.js +++ b/src/docs/react-storybook/basics/quick-start-guide.js @@ -23,6 +23,6 @@ export default { --- - To learn more about what \`getstorybook\` command does, have a look at our [Slow Start Guide](/docs/basics/slow-start-guide). + To learn more about what \`getstorybook\` command does, have a look at our [Slow Start Guide](/docs/react-storybook/basics/slow-start-guide). ` }; diff --git a/src/docs/react-storybook/basics/writing-stories.js b/src/docs/react-storybook/basics/writing-stories.js index d3eb1fbf9908..9dc83522ad5d 100644 --- a/src/docs/react-storybook/basics/writing-stories.js +++ b/src/docs/react-storybook/basics/writing-stories.js @@ -47,7 +47,7 @@ export default { ![](${images.basicsStories}) - This is just our core API for writing stories. In addition to this, you can use the official and third part Storybook [addons](/docs/addons/introduction) to get more functionality. + This is just our core API for writing stories. In addition to this, you can use the official and third part Storybook [addons](/docs/react-storybook/addons/introduction) to get more functionality. ## Loading stories dynamically diff --git a/src/docs/react-storybook/configurations/custom-webpack-config.js b/src/docs/react-storybook/configurations/custom-webpack-config.js index d0a3e5c43497..5bb85054ecdf 100644 --- a/src/docs/react-storybook/configurations/custom-webpack-config.js +++ b/src/docs/react-storybook/configurations/custom-webpack-config.js @@ -34,7 +34,7 @@ export default { You also need to install the loaders (style, css, and sass) used in above config manually. - > Once you create this \`webpack.config.js\` file, Storybook won't load the [default Webpack config](/docs/configurations/default-config) other than loading JS files with the Babel loader. + > Once you create this \`webpack.config.js\` file, Storybook won't load the [default Webpack config](/docs/react-storybook/configurations/default-config) other than loading JS files with the Babel loader. ### Supported Webpack Options @@ -80,7 +80,7 @@ export default { ## Extending The Default Config - You may want to keep Storybook's [default config](/docs/configurations/default-config), but just need to extend it. If so, this is how you do it using the Full Control Mode. + You may want to keep Storybook's [default config](/docs/react-storybook/configurations/default-config), but just need to extend it. If so, this is how you do it using the Full Control Mode. Add following content to the \`webpack.config.js\` in your Storybook config directory. ~~~js diff --git a/src/docs/react-storybook/configurations/env-vars.js b/src/docs/react-storybook/configurations/env-vars.js index b6a33cf3a7ab..abe0f63d1096 100644 --- a/src/docs/react-storybook/configurations/env-vars.js +++ b/src/docs/react-storybook/configurations/env-vars.js @@ -25,7 +25,7 @@ export default { ## Build time environment variables - You can also pass these environment variables when you are [building your storybook](http://localhost:3000/docs/basics/exporting-storybook) with \`build-storybook\`. + You can also pass these environment variables when you are [building your storybook](http://localhost:3000/docs/react-storybook/basics/exporting-storybook) with \`build-storybook\`. Then they'll be hard coded to the static version of your Storybook. diff --git a/src/docs/react-storybook/configurations/serving-static-files.js b/src/docs/react-storybook/configurations/serving-static-files.js index ea1929ddb6db..c0b671c7f3a9 100644 --- a/src/docs/react-storybook/configurations/serving-static-files.js +++ b/src/docs/react-storybook/configurations/serving-static-files.js @@ -26,7 +26,7 @@ export default { ~~~ - This is enabled with our [default config](/docs/configurations/default-config). But, if you are using a [custom Webpack config](/docs/configurations/custom-webpack-config), you need to add the [file-loader](https://github.com/webpack/file-loader) into your custom Webpack config. + This is enabled with our [default config](/docs/react-storybook/configurations/default-config). But, if you are using a [custom Webpack config](/docs/react-storybook/configurations/custom-webpack-config), you need to add the [file-loader](https://github.com/webpack/file-loader) into your custom Webpack config. ## 2. Via a Directory diff --git a/src/docs/react-storybook/testing/css-style-testing.js b/src/docs/react-storybook/testing/css-style-testing.js index 80bc2e6df151..c17942f86870 100644 --- a/src/docs/react-storybook/testing/css-style-testing.js +++ b/src/docs/react-storybook/testing/css-style-testing.js @@ -29,7 +29,7 @@ export default { ## Supported CSS/Style Testing Frameworks - It will be hard to use all the frameworks we've [mentioned](/docs/testing/react-ui-testing#3-css-style-testing), but we'll be able to use frameworks which are based on URL as the input source. (Such as [BackstopJS](https://github.com/garris/BackstopJS) and [Gemini](https://github.com/gemini-testing/gemini)) + It will be hard to use all the frameworks we've [mentioned](/docs/react-storybook/testing/react-ui-testing#3-css-style-testing), but we'll be able to use frameworks which are based on URL as the input source. (Such as [BackstopJS](https://github.com/garris/BackstopJS) and [Gemini](https://github.com/gemini-testing/gemini)) > In the future we are also planning to smooth this process with the help of [StoryShots](https://github.com/kadirahq/storyshots). ` diff --git a/src/docs/react-storybook/testing/react-ui-testing.js b/src/docs/react-storybook/testing/react-ui-testing.js index 85071610be6a..2c7a85ee28f8 100644 --- a/src/docs/react-storybook/testing/react-ui-testing.js +++ b/src/docs/react-storybook/testing/react-ui-testing.js @@ -73,9 +73,9 @@ export default { Let's look at how Storybook can help you do the above mentioned different aspects of testing. - * [Structural Testing with StoryShots](/docs/testing/structural-testing) - * [Interaction Testing with Specs Addon](/docs/testing/interaction-testing) - * [Storybook as the Base for CSS/Style Testing](/docs/testing/css-style-testing) - * [Storybook for Manual UI Testing](/docs/testing/manual-testing) + * [Structural Testing with StoryShots](/docs/react-storybook/testing/structural-testing) + * [Interaction Testing with Specs Addon](/docs/react-storybook/testing/interaction-testing) + * [Storybook as the Base for CSS/Style Testing](/docs/react-storybook/testing/css-style-testing) + * [Storybook for Manual UI Testing](/docs/react-storybook/testing/manual-testing) ` }; diff --git a/src/docs/storybook-hub/management-features/env-variables.js b/src/docs/storybook-hub/management-features/env-variables.js index 533f9df5d162..0456642b042c 100644 --- a/src/docs/storybook-hub/management-features/env-variables.js +++ b/src/docs/storybook-hub/management-features/env-variables.js @@ -7,7 +7,7 @@ export default { id: "env-variables", title: "Environment Varibles", content: stripIndent` - You can pass dynamic information to Storybook via environmental variables. This can be used to pass configurations and secrets. Here's [how to](https://getstorybook.io/docs/configurations/env-vars) use them with storybook. + You can pass dynamic information to Storybook via environmental variables. This can be used to pass configurations and secrets. Here's [how to](https://getstorybook.io/docs/react-storybook/configurations/env-vars) use them with storybook. As you expected, you can set env variables directly from Storybook Hub. Therefore, you don't need to commit those configuration into GitHub or any other store.