Skip to content

Commit

Permalink
sync with monorepo gatsbyjs/gatsby@2be3cb3 - fix NPM -> npm (#25355)
Browse files Browse the repository at this point in the history
  • Loading branch information
gatsbybot committed Jul 8, 2020
1 parent ff73000 commit dfc89f5
Show file tree
Hide file tree
Showing 12 changed files with 15 additions and 15 deletions.
2 changes: 1 addition & 1 deletion docs/contributing/setting-up-your-local-dev-environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This page outlines how to get set up to contribute to Gatsby core and its ecosys
## Using Yarn

Yarn is a package manager for your code, similar to [NPM](https://www.npmjs.com/). While NPM is used to develop Gatsby sites with the CLI, contributing to the Gatsby repo requires Yarn for the following reason: we use Yarn's [workspaces](https://yarnpkg.com/lang/en/docs/workspaces/) feature that comes really handy for monorepos. It allows us to install dependencies from multiple `package.json` files in sub-folders, enabling a faster and lighter installation process.
Yarn is a package manager for your code, similar to [npm](https://www.npmjs.com/). While npm is used to develop Gatsby sites with the CLI, contributing to the Gatsby repo requires Yarn for the following reason: we use Yarn's [workspaces](https://yarnpkg.com/lang/en/docs/workspaces/) feature that comes really handy for monorepos. It allows us to install dependencies from multiple `package.json` files in sub-folders, enabling a faster and lighter installation process.

```json:title=package.json
{
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/creating-a-transformer-plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ This loose coupling between the data source and transformer plugins allow Gatsby

## How do you create a transformer plugin?

Just like a source plugin, a transformer plugin is a normal NPM package. It has a `package.json` file with optional dependencies as well as a `gatsby-node.js` file where you implement Gatsby's Node.js APIs.
Just like a source plugin, a transformer plugin is a normal npm package. It has a `package.json` file with optional dependencies as well as a `gatsby-node.js` file where you implement Gatsby's Node.js APIs.

`gatsby-transformer-yaml` is transformer plugin that looks for new nodes with a media type of text/YAML (e.g. a `.yaml` file) and creates new YAML child node(s) by parsing the YAML source into JavaScript objects.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/debugging-html-builds.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ const module = typeof window !== `undefined` ? require("module") : null

## Fixing third-party modules

So, the worst has happened and you're using an NPM module that expects `window`
So, the worst has happened and you're using an npm module that expects `window`
to be defined. You may be able to file an issue and get the module patched, but
what to do in the mean time?

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/deploying-to-clodui.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Clodui supports the following features to improve your website speed and develop

Follow these steps to deploy your website to Clodui.

1. [Sign up](https://app.clodui.com/auth/signup) to create an account using your email and password.
1. [Sign up](https://app.clodui.com/auth/signup) to create an account using your email and password.
_**Note :** Don't use social login like Google or Facebook to sign up because Clodui CLI doesn't support it yet._
2. Install the [Clodui CLI]:
```shell
Expand Down Expand Up @@ -89,7 +89,7 @@ Here Clodui credentials and website id are fetched from the GitHub secret store.
- [Clodui CLI documentation](https://www.clodui.com/docs/clodui-cli/)
- [Clodui Actions marketplace](https://github.com/marketplace/actions/clodui-actions)
- [Clodui CLI NPM package](https://www.npmjs.com/package/@clodui/cli)
- [Clodui CLI npm package](https://www.npmjs.com/package/@clodui/cli)
[clodui]: https://www.clodui.com
[clodui cli]: https://www.npmjs.com/package/@clodui/cli
2 changes: 1 addition & 1 deletion docs/docs/environment-variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ MY_ENV_VAR=foo npm run develop
In Windows it's a little more complex. [Check out this Stack Overflow article for some options](https://stackoverflow.com/questions/1420719/powershell-setting-an-environment-variable-for-a-single-command-only)

Project environment variables that you defined in the `.env.*` files will _NOT_ be immediately available
in your Node.js scripts. To use those variables, use NPM package [dotenv](https://www.npmjs.com/package/dotenv) to
in your Node.js scripts. To use those variables, use npm package [dotenv](https://www.npmjs.com/package/dotenv) to
examine the active `.env.*` file and attach those values.
`dotenv` is already a dependency of Gatsby, so you can require it in your `gatsby-config.js` or `gatsby-node.js` like this:

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/gatsby-lifecycle-apis.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Gatsby's design principles include:
code.
- Extracting logic and configuration into [plugins](/docs/plugins/) should be
trivial and encouraged.
- Plugins are easy to open source and reuse. They're just NPM packages.
- Plugins are easy to open source and reuse. They're just npm packages.

## High level Overview

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/gatsby-on-windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ further instructions and contact the `node-gyp`team on

## gatsby-plugin-sharp requires Node x64

Some plugins which depend on native NPM dependencies require the Node x64 build of Node.js. If you're struggling to install gatsby-plugin-sharp, try installing Node x64 and removing `node_modules` and running `npm install`.
Some plugins which depend on native npm dependencies require the Node x64 build of Node.js. If you're struggling to install gatsby-plugin-sharp, try installing Node x64 and removing `node_modules` and running `npm install`.

## gatsby-plugin-sharp requires libvips

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@ A program that lets you run [JavaScript](#javascript) on your computer. Gatsby i

### Package

A package usually describes a [JavaScript](#javascript) program that has additional information about how it should be distributed and used, such as its version number. [NPM](#npm) and [Yarn](#yarn) manages and installs the packages your project uses. [Gatsby](#gatsby) itself is a package.
A package usually describes a [JavaScript](#javascript) program that has additional information about how it should be distributed and used, such as its version number. [npm](#npm) and [Yarn](#yarn) manages and installs the packages your project uses. [Gatsby](#gatsby) itself is a package.

### Page

Expand Down Expand Up @@ -376,6 +376,6 @@ A WordPress plugin that adds [GraphQL](#graphql) capabilities to WordPress. It's

### [Yarn](/docs/glossary/yarn/)

A [package](#package) manager that some prefer to [NPM](#npm). It is also required for [developing Gatsby](/contributing/setting-up-your-local-dev-environment/#using-yarn).
A [package](#package) manager that some prefer to [npm](#npm). It is also required for [developing Gatsby](/contributing/setting-up-your-local-dev-environment/#using-yarn).

## Z
4 changes: 2 additions & 2 deletions docs/docs/setting-up-gatsby-without-gatsby-new.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Setting up a Gatsby Site Without the `gatsby new` Command
---

There are many Enterprise level companies that maintain an internal clone of the NPM registry for security purposes. If you work for such a company, you may find that you are able to successfully run `npm install -g gatsby-cli` but cannot run the `gatsby new <project-source>` as the `gatsby new` command clones a repo from a public GitHub repository. Many companies block public GitHub, which will cause the `gatsby new` command to fail. Not to worry, though, you can set up a new Gatsby site without the `gatsby new` command with a few quick steps.
There are many Enterprise level companies that maintain an internal clone of the npm registry for security purposes. If you work for such a company, you may find that you are able to successfully run `npm install -g gatsby-cli` but cannot run the `gatsby new <project-source>` as the `gatsby new` command clones a repo from a public GitHub repository. Many companies block public GitHub, which will cause the `gatsby new` command to fail. Not to worry, though, you can set up a new Gatsby site without the `gatsby new` command with a few quick steps.

## Preparing your environment

Expand All @@ -20,7 +20,7 @@ mkdir my-new-gatsby-site
cd my-new-gatsby-site
```

Next, you'll need to set up NPM within your project.
Next, you'll need to set up npm within your project.

```shell
npm init
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/using-a-plugin-in-your-site.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Using a Plugin in Your Site
---

Gatsby plugins are Node.js packages, so you can install them like other packages in node using NPM.
Gatsby plugins are Node.js packages, so you can install them like other packages in node using npm.

For example, `gatsby-transformer-json` is a package that adds support for JSON files to the Gatsby data layer.

Expand Down
2 changes: 1 addition & 1 deletion docs/tutorial/part-three/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ cd tutorial-part-three

There are two main steps to using a plugin: Installing and configuring.

1. Install the `gatsby-plugin-typography` NPM package.
1. Install the `gatsby-plugin-typography` npm package.

```shell
npm install --save gatsby-plugin-typography react-typography typography typography-theme-fairy-gates
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorial/remark-plugin-tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,7 @@ At this point, our plugin is now ready to be used. To see the resulting function

## Publishing the plugin

To share this plugin with others, you can extract the plugin to its own directory outside of this site and then publish it to NPM so it can be accessed both on NPM and [Submitted to the Plugin Library](/contributing/submit-to-plugin-library).
To share this plugin with others, you can extract the plugin to its own directory outside of this site and then publish it to npm so it can be accessed both on npm and [Submitted to the Plugin Library](/contributing/submit-to-plugin-library).

## Summary

Expand Down

0 comments on commit dfc89f5

Please sign in to comment.