Skip to content

Commit 3620cd0

Browse files
hugovkDSchau
authored andcommitted
Make text a little less wordy, as people generally don't read long text on-screen (#9494)
As suggested by @calcsam in #9120 (comment), here's my review comments in its own PR. Follows https://www.gatsbyjs.org/docs/gatsby-style-guide/#write-concisely cc @kkemple @shannonbux Also use “you” as the pronoun, following the [style guide](https://www.gatsbyjs.org/docs/gatsby-style-guide/#use-you-as-the-pronoun). <!-- Q. Which branch should I use for my pull request? A. Use `master` branch (probably). Q. Which branch if my change is a bug fix for Gatsby v1? A. In this case, you should use the `v1` branch Q. Which branch if I'm still not sure? A. Use `master` branch. Ask in the PR if you're not sure and a Gatsby maintainer will be happy to help :) Note: We will only accept bug fixes for Gatsby v1. New features should be added to Gatsby v2. Learn more about contributing: https://www.gatsbyjs.org/docs/how-to-contribute/ -->
1 parent dbd71c3 commit 3620cd0

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

docs/docs/visual-testing-with-storybook.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ As your project grows over time having this information available will be invalu
1111

1212
## Setting up your environment
1313

14-
In order to set up Storybook you will need to install a few dependencies and then do some custom configuration to make Storybook work with your Gatsby environment. The first thing is to get the Storybook CLI installed if you don't have it already.
14+
To set up Storybook you need to install dependencies and do some custom configuration. First, install the Storybook CLI.
1515

1616
```sh
1717
npm install -g @storybook/cli
@@ -24,13 +24,13 @@ cd my-awesome-gatsby-project
2424
getstorybook
2525
```
2626

27-
The `getstorybook` command will then bootstrap the basic config necessary to run Storybook for a React project. However, since this is for a Gatsby project, we need to update the default Storybook configuration a bit so that we don't get errors when trying to use Gatsby specific components inside of the stories.
27+
The `getstorybook` command will then bootstrap the basic config necessary to run Storybook for a React project. However, since this is for a Gatsby project, you need to update the default Storybook configuration a bit so that you don't get errors when trying to use Gatsby specific components inside of the stories.
2828

2929
To update your Storybook config open `.storybook/config.js` and add the following before the `configure` method at the bottom of the file.
3030

3131
```js
3232
// Gatsby's Link overrides:
33-
// Gatsby defines a global called ___loader to prevent its method calls from creating console errors we override it here
33+
// Gatsby defines a global called ___loader to prevent its method calls from creating console errors you override it here
3434
global.___loader = {
3535
enqueue: () => {},
3636
hovering: () => {},
@@ -45,7 +45,7 @@ window.___navigate = pathname => {
4545
}
4646
```
4747

48-
Next we need up make some adjustments to Storybook's default `webpack` configuration so that we can tranpile Gatsby source files, as well as ensure we have all the necessary `babel` plugins we need to transpile Gatsby components.
48+
Next make some adjustments to Storybook's default `webpack` configuration so you can transpile Gatsby source files, and to ensure you have the necessary `babel` plugins to transpile Gatsby components.
4949

5050
Create a new file called `webpack.config.js` in the `.storybook` folder created by the Storybook CLI. Then place the following in that file.
5151

@@ -84,7 +84,7 @@ Storybook CLI adds this command to your `package.json` for you so you shouldn't
8484

8585
A full guide to writing stories is beyond the scope of this guide, but we'll take a look at creating a story.
8686

87-
First, create the story file. Storybook looks for all files with a `.story.js` extension and loads them into Storybook for you. Generally you will want your stories near where the component is defined, however since this Gatsby, if you want stories for your pages, you will have to create those files outside of the `pages` directory.
87+
First, create the story file. Storybook looks for all files with a `.story.js` extension and loads them into Storybook for you. Generally you will want your stories near where the component is defined, however since this is Gatsby, if you want stories for your pages, you will have to create those files outside of the `pages` directory.
8888

8989
> A good solution is to create a `__stories__` directory next to your `pages` directory and put any page stories in there.
9090

0 commit comments

Comments
 (0)