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.

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

chore(docs): Fix multiple grammar issues #31946

Merged
merged 1 commit into from
Jun 17, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/gatsby-cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ At the root of a Gatsby app run `gatsby build` to do a production build of a sit
| `--open-tracing-config-file` | Tracer configuration file (OpenTracing compatible). See https://www.gatsbyjs.org/docs/performance-tracing/ | |
| `--no-color`, `--no-colors` | Disables colored terminal output | `false` |

For prefixing paths, most will want to use the CLI flag (`gatsby build --prefix-paths`). For environments where you can't pass the --prefix-paths flag (ie Gatsby Cloud),the environment variable `PREFIX_PATHS` can be set to `true` to provide another way to prefix paths.
For prefixing paths, most will want to use the CLI flag (`gatsby build --prefix-paths`). For environments where you can't pass the --prefix-paths flag (ie Gatsby Cloud), the environment variable `PREFIX_PATHS` can be set to `true` to provide another way to prefix paths.

### `serve`

Expand All @@ -117,7 +117,7 @@ At the root of a Gatsby app run `gatsby serve` to serve the production build of
| `-o`, `--open` | Open the site in your (default) browser for you | |
| `--prefix-paths` | Serve site with link paths prefixed (if built with pathPrefix in your gatsby-config.js). | `env.PREFIX_PATHS` or `false` |

For prefixing paths, most will want to use the CLI flag (`gatsby build --prefix-paths`). For environments where you can't pass the --prefix-paths flag (ie Gatsby Cloud),the environment variable `PREFIX_PATHS` can be set to `true` to provide another way to prefix paths.
For prefixing paths, most will want to use the CLI flag (`gatsby build --prefix-paths`). For environments where you can't pass the --prefix-paths flag (ie Gatsby Cloud), the environment variable `PREFIX_PATHS` can be set to `true` to provide another way to prefix paths.

### `clean`

Expand Down
2 changes: 1 addition & 1 deletion packages/gatsby-codemods/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ npx gatsby-codemods <codemod-name> <filepath>

`filepath` is not required and will default to the directory you're currently in.

Note that you cannot pass additional flags to this command. It will automatically run the codemod against file extenstions `js, jsx, ts, tsx` and ignore the `node_modules`, `.cache` and `public` directories of your project.
Note that you cannot pass additional flags to this command. It will automatically run the codemod against file extensions `js, jsx, ts, tsx` and ignore the `node_modules`, `.cache` and `public` directories of your project.

2. Use JSCodeshift directly

Expand Down
4 changes: 2 additions & 2 deletions packages/gatsby-design-tokens/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Gatsby's design tokens are following the [System UI Theme Specification](https:/

- Minor fixes to tokens will be released as patch versions.
- Major design changes will be released as minor versions
- _Breaking_ public API changes will be released in a major versions only.
- _Breaking_ public API changes will be released in major versions only.

To prevent your site from breaking due to a breaking change or looking dramatically different due to a minor version bump, we recommend the [~](https://docs.npmjs.com/misc/semver#tilde-ranges-123-12-1) comparator when using this package.

Expand Down Expand Up @@ -182,7 +182,7 @@ Follow the [official guide](https://www.gatsbyjs.org/contributing/setting-up-you
git clone https://github.com/gatsbyjs/gatsby.git
cd gatsby

# set up the repo,install dependencies for `packages`, and build the latter
# set up the repo, install dependencies for `packages`, and build the latter
yarn run bootstrap

# make sure tests are passing
Expand Down
6 changes: 3 additions & 3 deletions packages/gatsby-dev-cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ watchers to build Gatsby source code.

## Revert to current packages

If you've recently run `gatsby-dev` your `node_modules` will be out of sync with current published packages. In order to undo this, you can remove the `node_modules` directory or run:
If you've recently run `gatsby-dev` your `node_modules` will be out of sync with currently published packages. In order to undo this, you can remove the `node_modules` directory or run:

```shell
git checkout package.json; yarn --force
Expand All @@ -47,7 +47,7 @@ git checkout package.json; npm install --force

**[Demo Video](https://www.youtube.com/watch?v=D0SwX1MSuas)**

More detailed instruction for setting up your Gatsby development environment can
More detailed instructions for setting up your Gatsby development environment can
be found [here](https://www.gatsbyjs.org/contributing/how-to-contribute/).

### Other commands
Expand Down Expand Up @@ -78,4 +78,4 @@ Copy all modules/files in the gatsby source repo in packages/

#### `--force-install`

Disables copying files into node_modules and forces usage of local npm repository.
Disable copying files into node_modules and force usage of local npm repository.
2 changes: 1 addition & 1 deletion packages/gatsby-plugin-gatsby-cloud/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ An asterix, `*`, will match anything that follows. i.e. `/packages/gatsby-plugin

[HSTS Cheatsheet](https://cheatsheetseries.owasp.org/cheatsheets/HTTP_Strict_Transport_Security_Cheat_Sheet.html)

Since this header is an opt-in security enhancement with permanent consequences we don't include it as a default feature but use can use the `allPagesHeaders` to include it.
Since this header is an opt-in security enhancement with permanent consequences we don't include it as a default feature but use the `allPagesHeaders` to include it.

```javascript
{
Expand Down