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.

Sign up for GitHub

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

Adds NPM article. #22942

Merged
merged 9 commits into from
Apr 9, 2020
Merged

Adds NPM article. #22942

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
d82be08
Adds NPM article.
webinista Apr 6, 2020
83973a9
Update docs/docs/glossary.md
webinista Apr 8, 2020
0fdfb26
Update docs/docs/glossary/npm.md
webinista Apr 8, 2020
92c9f31
Update docs/docs/glossary/npm.md
webinista Apr 8, 2020
a830df3
Update docs/docs/glossary/npm.md
webinista Apr 8, 2020
7d3bd97
Update docs/docs/glossary/npm.md: Clarify global installation
webinista Apr 8, 2020
70f58ae
Update docs/docs/glossary.md
webinista Apr 9, 2020
bbf15cf
Update docs/docs/glossary/npm.md
webinista Apr 9, 2020
89b9dc3
Update docs/docs/glossary/npm.md
webinista Apr 9, 2020
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
Prev Previous commit
Update docs/docs/glossary/npm.md 
Change NPM to npm for style, consistency.

Co-Authored-By: Aisha Blake <aisha@gatsbyjs.com>
  • Loading branch information
@webinista
webinista and Aisha Blake authored Apr 9, 2020
commit 89b9dc3eff5553022a53c2cea5bbb3ea8d535ce8
2 changes: 1 addition & 1 deletion docs/docs/glossary/npm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Once the installation completes, you can run `gatsby new my-project` to create a

### Using npx to install Gatsby
Copy link

Choose a reason for hiding this comment

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

I started to write a comment about not needing to install globally before seeing this section. The previous section could potentially use a little clarification on that point. Once a reader gets to this section, though, I think things become clearer.

Copy link
Contributor Author

@webinista webinista Apr 8, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

So instead of:

Since Gatsby needs to be installed globally as a CLI app ...

Maybe this should be:

It's recommended to install Gatsby globally, as a CLI app. Doing so allows you to use the gatsby command to easily create new and manage new projects.

Copy link

Choose a reason for hiding this comment

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

@webinista I've added another suggestion which feels a bit more active/clear to me. Let me know what you think?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah. That's a better way to phrase it. Thanks!


> **Note:** `npx` requires npm version 5.2 or later. If you've installed the latest versions of Node and NPM, you should also have npx. Otherwise, you should upgrade Node and/or npm.
> **Note:** `npx` requires npm version 5.2 or later. If you've installed the latest versions of Node and npm, you should also have npx. Otherwise, you should upgrade Node and/or npm.

You can also use [npx](https://www.npmjs.com/package/npx) to install Gatsby. npx ships with npm. It allows you to install a package and run a command in one step. For example, instead of running `npm install -g gatsby-cli` then `gatsby new my-project`, you could use the following command.

Expand Down