From ccdc128644b8b94962d7865b643ef5d740d985cf Mon Sep 17 00:00:00 2001 From: Divyanshu Maithani Date: Tue, 15 Oct 2019 09:18:02 +0000 Subject: [PATCH] chore(docs): clarify local setup instructions (#18406) * docs: clarify local setup instructions * update wording * remove node version note * docs: specify lts version for node Co-authored-by: Lennart Co-authored-by: GatsbyJS Bot --- docs/contributing/docs-contributions.md | 2 +- docs/contributing/setting-up-your-local-dev-environment.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/contributing/docs-contributions.md b/docs/contributing/docs-contributions.md index 50142025f5020..cb2924025b014 100644 --- a/docs/contributing/docs-contributions.md +++ b/docs/contributing/docs-contributions.md @@ -88,7 +88,7 @@ After going through the [development setup instructions](/contributing/setting-u - For docs-only changes, consider using `git checkout -b docs/some-change` or `git checkout -b docs-some-change`, as this will short circuit the CI process and only run linting tasks. - Change directories into the docs site folder: `cd www` - Install dependencies with Yarn: `yarn install` -- Add the following env variable to an `.env.development` file to [enable image placeholders](https://github.com/gatsbyjs/gatsby/tree/master/www#running-slow-build-screenshots-placeholder): `GATSBY_SCREENSHOT_PLACEHOLDER=true`. This will speed up building the docs site significantly! +- Add the following env variable to an `.env.development` file inside the `www` directory to [enable image placeholders](https://github.com/gatsbyjs/gatsby/tree/master/www#running-slow-build-screenshots-placeholder): `GATSBY_SCREENSHOT_PLACEHOLDER=true`. This will speed up building the docs site significantly! - Start a build of `www` with `gatsby develop`. - Edit Markdown files in the [docs](https://github.com/gatsbyjs/gatsby/tree/master/docs) and [contributing](https://github.com/gatsbyjs/gatsby/tree/master/docs/contributing) folders, as well as the [YAML sidebar files](https://github.com/gatsbyjs/gatsby/tree/master/www/src/data/sidebars). - View the changes in your browser at `http://localhost:8000`. diff --git a/docs/contributing/setting-up-your-local-dev-environment.md b/docs/contributing/setting-up-your-local-dev-environment.md index 3baeb5b294fec..2716ed270e7f2 100644 --- a/docs/contributing/setting-up-your-local-dev-environment.md +++ b/docs/contributing/setting-up-your-local-dev-environment.md @@ -19,7 +19,7 @@ Yarn is a package manager for your code, similar to [NPM](https://www.npmjs.com/ ## Gatsby repo install instructions -- Ensure you have the latest version of Node installed (>= 10.16.0). `node --version` +- Ensure you have the latest **LTS** version of Node installed (>= 10.16.0). `node --version` - [Install](https://yarnpkg.com/en/docs/install) the Yarn package manager. - Ensure you have the latest version of Yarn installed (>= 1.0.2). `yarn --version` - Fork the [official repository](https://github.com/gatsbyjs/gatsby).