-
Notifications
You must be signed in to change notification settings - Fork 10.3k
Closed
Labels
good first issueIssue that doesn't require previous experience with GatsbyIssue that doesn't require previous experience with Gatsbyhelp wantedIssue with a clear description that the community can help with.Issue with a clear description that the community can help with.type: documentationAn issue or pull request for improving or updating Gatsby's documentationAn issue or pull request for improving or updating Gatsby's documentation
Description
Summary
Unify npm install commands in docs and all README
Suggested changes:
- 1) remove
--savefromnpm install - 2) replace
npm iwithnpm install - 3) put
--save-devas first param after install
(npm install dep1 dep2 --save-dev->npm install --save-dev dep1 dep2) - 4) put commands in code blocks for better copy paste
Motivation
-
--saveis not anymore needed - see cpmments:- Put install in its own code block #22359 (comment)
laurieontech: --save is no longer necessary for modern versions of npm, but overall this looks like a solid change!
- fix(docs): improve WordPress tutorial #20520 (comment)
gillkyle: This brings up a good point as something that might be good to start updating across docs elsewhere.
npm 5.0.0 was apparently the version to remove the need to add --save which was published more than 3 years ago
- Put install in its own code block #22359 (comment)
-
i->installmore easy to know for new users whatimeans -
--save-devmore visible option -
Putting the install snippet in its own code block makes it easier for people to copy the snippet. I believe this is also consistent with other doc pages. (Put install in its own code block #22359)
Steps to resolve this issue
Draft the doc
- Write the doc, following the format listed in these resources:
- Add the article to the docs sidebar under the [parent doc] section.
Open a pull request
- Open a pull request with your work including the words "closes #[this issue's number]" in the pull request description
raulrpearson, TylerBarnes and AishaBlake
Metadata
Metadata
Assignees
Labels
good first issueIssue that doesn't require previous experience with GatsbyIssue that doesn't require previous experience with Gatsbyhelp wantedIssue with a clear description that the community can help with.Issue with a clear description that the community can help with.type: documentationAn issue or pull request for improving or updating Gatsby's documentationAn issue or pull request for improving or updating Gatsby's documentation