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): clarify local setup instructions #18406

Merged
merged 5 commits into from
Oct 15, 2019
Merged

chore(docs): clarify local setup instructions #18406

merged 5 commits into from
Oct 15, 2019

Conversation

divyanshu013
Copy link
Contributor

@divyanshu013 divyanshu013 commented Oct 9, 2019

Description

Clarify a few instructions that I found confusing during local setup for docs site:

  • Verify node version. I was unable to build the project on latest node 12
  • Specify location of .env.development file for docs site

On a related note, even after adding the environment variable in .env.develpment file the build process still took time to generate thumbnails. I followed the instructions as mentioned here.

Since this looked like a small enough change I considered opening a PR directly. Please let me know if anything else helps. Thanks!

@divyanshu013 divyanshu013 requested a review from a team as a code owner October 9, 2019 19:26
LekoArts
LekoArts previously approved these changes Oct 14, 2019
Copy link
Contributor

@LekoArts LekoArts left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! 👍

@LekoArts LekoArts changed the title docs: clarify local setup instructions chore(docs): clarify local setup instructions Oct 14, 2019
@LekoArts LekoArts added the bot: merge on green Gatsbot will merge these PRs automatically when all tests passes label Oct 14, 2019
pieh
pieh previously requested changes Oct 14, 2019
docs/contributing/setting-up-your-local-dev-environment.md Outdated Show resolved Hide resolved
LekoArts
LekoArts previously approved these changes Oct 14, 2019
Copy link
Contributor

@LekoArts LekoArts left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@divyanshu013
Copy link
Contributor Author

Thanks for addressing @LekoArts. The related PR #18551 doesn't specify the node version to be LTS. During my local setup, I was unable to build on latest node 12, hence the original mention of LTS in this PR.

@LekoArts LekoArts added type: documentation An issue or pull request for improving or updating Gatsby's documentation and removed bot: merge on green Gatsbot will merge these PRs automatically when all tests passes labels Oct 14, 2019
@LekoArts
Copy link
Contributor

Good point! Feel free to add that note in the current sentence then 👍

Copy link
Contributor

@LekoArts LekoArts left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks 👍

@LekoArts LekoArts merged commit ccdc128 into gatsbyjs:master Oct 15, 2019
@divyanshu013 divyanshu013 deleted the docs/setup-node-version branch October 15, 2019 09:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation An issue or pull request for improving or updating Gatsby's documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants