Skip to content

Commit

Permalink
docs: keep the npm- prefix for commands
Browse files Browse the repository at this point in the history
Again, this reflects the path hierarchy and structure, and matches the
old documentation URLs.
  • Loading branch information
ethomson authored and isaacs committed Oct 23, 2020
1 parent 6522365 commit 47a42bd
Show file tree
Hide file tree
Showing 69 changed files with 231 additions and 233 deletions.
6 changes: 3 additions & 3 deletions docs/content/commands/npm-access.md
Expand Up @@ -84,7 +84,7 @@ Management of teams and team memberships is done with the `npm team` command.
### See Also
* [`libnpmaccess`](https://npm.im/libnpmaccess)
* [npm team](/commands/team)
* [npm publish](/commands/publish)
* [npm config](/commands/config)
* [npm team](/commands/npm-team)
* [npm publish](/commands/npm-publish)
* [npm config](/commands/npm-config)
* [npm registry](/using-npm/registry)
6 changes: 3 additions & 3 deletions docs/content/commands/npm-adduser.md
Expand Up @@ -85,7 +85,7 @@ username/password entry in legacy npm.
### See Also

* [npm registry](/using-npm/registry)
* [npm config](/commands/config)
* [npm config](/commands/npm-config)
* [npmrc](/configuring-npm/npmrc)
* [npm owner](/commands/owner)
* [npm whoami](/commands/whoami)
* [npm owner](/commands/npm-owner)
* [npm whoami](/commands/npm-whoami)
2 changes: 1 addition & 1 deletion docs/content/commands/npm-audit.md
Expand Up @@ -189,6 +189,6 @@ $ npm audit --audit-level=moderate

### See Also

* [npm install](/commands/install)
* [npm install](/commands/npm-install)
* [package-locks](/configuring-npm/package-locks)
* [config](/using-npm/config)
6 changes: 3 additions & 3 deletions docs/content/commands/npm-bin.md
Expand Up @@ -16,8 +16,8 @@ Print the folder where npm will install executables.

### See Also

* [npm prefix](/commands/prefix)
* [npm root](/commands/root)
* [npm prefix](/commands/npm-prefix)
* [npm root](/commands/npm-root)
* [npm folders](/configuring-npm/folders)
* [npm config](/commands/config)
* [npm config](/commands/npm-config)
* [npmrc](/configuring-npm/npmrc)
8 changes: 4 additions & 4 deletions docs/content/commands/npm-bugs.md
Expand Up @@ -42,10 +42,10 @@ The base URL of the npm package registry.
### See Also
* [npm docs](/commands/docs)
* [npm view](/commands/view)
* [npm publish](/commands/publish)
* [npm docs](/commands/npm-docs)
* [npm view](/commands/npm-view)
* [npm publish](/commands/npm-publish)
* [npm registry](/using-npm/registry)
* [npm config](/commands/config)
* [npm config](/commands/npm-config)
* [npmrc](/configuring-npm/npmrc)
* [package.json](/configuring-npm/package-json)
8 changes: 4 additions & 4 deletions docs/content/commands/npm-cache.md
Expand Up @@ -82,11 +82,11 @@ The root cache folder.
### See Also

* [npm folders](/configuring-npm/folders)
* [npm config](/commands/config)
* [npm config](/commands/npm-config)
* [npmrc](/configuring-npm/npmrc)
* [npm install](/commands/install)
* [npm publish](/commands/publish)
* [npm pack](/commands/pack)
* [npm install](/commands/npm-install)
* [npm publish](/commands/npm-publish)
* [npm pack](/commands/npm-pack)
* https://npm.im/cacache
* https://npm.im/pacote
* https://npm.im/@npmcli/arborist
Expand Down
2 changes: 1 addition & 1 deletion docs/content/commands/npm-ci.md
Expand Up @@ -67,5 +67,5 @@ cache:

### See Also

* [npm install](/commands/install)
* [npm install](/commands/npm-install)
* [package-locks](/configuring-npm/package-locks)
2 changes: 1 addition & 1 deletion docs/content/commands/npm-config.md
Expand Up @@ -83,7 +83,7 @@ global config.
### See Also

* [npm folders](/configuring-npm/folders)
* [npm config](/commands/config)
* [npm config](/commands/npm-config)
* [package.json](/configuring-npm/package-json)
* [npmrc](/configuring-npm/npmrc)
* [npm](/commands/npm)
2 changes: 1 addition & 1 deletion docs/content/commands/npm-deprecate.md
Expand Up @@ -31,7 +31,7 @@ format an empty string.

### See Also

* [npm publish](/commands/publish)
* [npm publish](/commands/npm-publish)
* [npm registry](/using-npm/registry)
* [npm owner](/cli-commands/owner)
* [npm owner](/cli-commands/adduser)
8 changes: 4 additions & 4 deletions docs/content/commands/npm-dist-tag.md
Expand Up @@ -90,9 +90,9 @@ not begin with a number or the letter `v`.

### See Also

* [npm publish](/commands/publish)
* [npm install](/commands/install)
* [npm dedupe](/commands/dedupe)
* [npm publish](/commands/npm-publish)
* [npm install](/commands/npm-install)
* [npm dedupe](/commands/npm-dedupe)
* [npm registry](/using-npm/registry)
* [npm config](/commands/config)
* [npm config](/commands/npm-config)
* [npmrc](/configuring-npm/npmrc)
6 changes: 3 additions & 3 deletions docs/content/commands/npm-docs.md
Expand Up @@ -43,9 +43,9 @@ The base URL of the npm package registry.
### See Also
* [npm view](/commands/view)
* [npm publish](/commands/publish)
* [npm view](/commands/npm-view)
* [npm publish](/commands/npm-publish)
* [npm registry](/using-npm/registry)
* [npm config](/commands/config)
* [npm config](/commands/npm-config)
* [npmrc](/configuring-npm/npmrc)
* [package.json](/configuring-npm/package-json)
6 changes: 3 additions & 3 deletions docs/content/commands/npm-doctor.md
Expand Up @@ -102,6 +102,6 @@ reset the cache.

### See Also

* [npm bugs](/commands/bugs)
* [npm help](/commands/help)
* [npm ping](/commands/ping)
* [npm bugs](/commands/npm-bugs)
* [npm help](/commands/npm-help)
* [npm ping](/commands/npm-ping)
6 changes: 3 additions & 3 deletions docs/content/commands/npm-edit.md
Expand Up @@ -36,7 +36,7 @@ The command to run for `npm edit` or `npm config edit`.
### See Also

* [npm folders](/configuring-npm/folders)
* [npm explore](/commands/explore)
* [npm install](/commands/install)
* [npm config](/commands/config)
* [npm explore](/commands/npm-explore)
* [npm install](/commands/npm-install)
* [npm config](/commands/npm-config)
* [npmrc](/configuring-npm/npmrc)
12 changes: 6 additions & 6 deletions docs/content/commands/npm-exec.md
Expand Up @@ -167,10 +167,10 @@ This resulted in some shifts in its functionality:

### See Also

* [npm run-script](/commands/run-script)
* [npm run-script](/commands/npm-run-script)
* [npm scripts](/using-npm/scripts)
* [npm test](/commands/test)
* [npm start](/commands/start)
* [npm restart](/commands/restart)
* [npm stop](/commands/stop)
* [npm config](/commands/config)
* [npm test](/commands/npm-test)
* [npm start](/commands/npm-start)
* [npm restart](/commands/npm-restart)
* [npm stop](/commands/npm-stop)
* [npm config](/commands/npm-config)
14 changes: 7 additions & 7 deletions docs/content/commands/npm-explain.md
Expand Up @@ -62,12 +62,12 @@ Show information in JSON format.

### See Also

* [npm config](/commands/config)
* [npm config](/commands/npm-config)
* [npmrc](/configuring-npm/npmrc)
* [npm folders](/configuring-npm/folders)
* [npm ls](/commands/ls)
* [npm install](/commands/install)
* [npm link](/commands/link)
* [npm prune](/commands/prune)
* [npm outdated](/commands/outdated)
* [npm update](/commands/update)
* [npm ls](/commands/npm-ls)
* [npm install](/commands/npm-install)
* [npm link](/commands/npm-link)
* [npm prune](/commands/npm-prune)
* [npm outdated](/commands/npm-outdated)
* [npm update](/commands/npm-update)
8 changes: 4 additions & 4 deletions docs/content/commands/npm-explore.md
Expand Up @@ -40,7 +40,7 @@ The shell to run for the `npm explore` command.
### See Also

* [npm folders](/configuring-npm/folders)
* [npm edit](/commands/edit)
* [npm rebuild](/commands/rebuild)
* [npm build](/commands/build)
* [npm install](/commands/install)
* [npm edit](/commands/npm-edit)
* [npm rebuild](/commands/npm-rebuild)
* [npm build](/commands/npm-build)
* [npm install](/commands/npm-install)
8 changes: 4 additions & 4 deletions docs/content/commands/npm-fund.md
Expand Up @@ -57,7 +57,7 @@ If there are multiple funding sources, which 1-indexed source URL to open.

## See Also

* [npm install](/commands/install)
* [npm docs](/commands/docs)
* [npm ls](/commands/ls)
* [npm config](/commands/config)
* [npm install](/commands/npm-install)
* [npm docs](/commands/npm-docs)
* [npm ls](/commands/npm-ls)
* [npm config](/commands/npm-config)
2 changes: 1 addition & 1 deletion docs/content/commands/npm-help-search.md
Expand Up @@ -36,4 +36,4 @@ If false, then help-search will just list out the help topics found.
### See Also

* [npm](/commands/npm)
* [npm help](/commands/help)
* [npm help](/commands/npm-help)
4 changes: 2 additions & 2 deletions docs/content/commands/npm-help.md
Expand Up @@ -34,7 +34,7 @@ Set to `"browser"` to view html help content in the default web browser.

* [npm](/commands/npm)
* [npm folders](/configuring-npm/folders)
* [npm config](/commands/config)
* [npm config](/commands/npm-config)
* [npmrc](/configuring-npm/npmrc)
* [package.json](/configuring-npm/package-json)
* [npm help-search](/commands/help-search)
* [npm help-search](/commands/npm-help-search)
2 changes: 1 addition & 1 deletion docs/content/commands/npm-init.md
Expand Up @@ -75,5 +75,5 @@ $ npm init -y

* [init-package-json module](http://npm.im/init-package-json)
* [package.json](/configuring-npm/package-json)
* [npm version](/commands/version)
* [npm version](/commands/npm-version)
* [npm scope](/using-npm/scope)
6 changes: 3 additions & 3 deletions docs/content/commands/npm-install-ci-test.md
Expand Up @@ -18,6 +18,6 @@ This command runs `npm ci` followed immediately by `npm test`.

### See Also

* [npm install-test](/commands/install-test)
* [npm ci](/commands/ci)
* [npm test](/commands/test)
* [npm install-test](/commands/npm-install-test)
* [npm ci](/commands/npm-ci)
* [npm test](/commands/npm-test)
6 changes: 3 additions & 3 deletions docs/content/commands/npm-install-test.md
Expand Up @@ -27,6 +27,6 @@ takes exactly the same arguments as `npm install`.

### See Also

* [npm install](/commands/install)
* [npm install-ci-test](/commands/install-ci-test)
* [npm test](/commands/test)
* [npm install](/commands/npm-install)
* [npm install-ci-test](/commands/npm-install-ci-test)
* [npm test](/commands/npm-test)
26 changes: 12 additions & 14 deletions docs/content/commands/npm-install.md
Expand Up @@ -35,17 +35,15 @@ following order of precedence:
* `yarn.lock`

See [package-lock.json](/configuring-npm/package-lock-json) and [`npm
shrinkwrap`](/commands/shrinkwrap).
shrinkwrap`](/commands/npm-shrinkwrap).

A `package` is:

* a) a folder containing a program described by a
[`package.json`](/configuring-npm/package-json) file
* b) a gzipped tarball containing (a)
* c) a url that resolves to (b)
* d) a `<name>@<version>` that is published on the registry (see
[`registry`](/using-npm/registry)) with (c)
* e) a `<name>@<tag>` (see [`npm dist-tag`](/commands/dist-tag)) that
* e) a `<name>@<tag>` (see [`npm dist-tag`](/commands/npm-dist-tag)) that
points to (d)
* f) a `<name>` that has a "latest" tag satisfying (e)
* g) a `<git remote url>` that resolves to (a)
Expand Down Expand Up @@ -532,18 +530,18 @@ the specific folder structures that npm creates.
### See Also
* [npm folders](/configuring-npm/folders)
* [npm update](/commands/update)
* [npm audit](/commands/audit)
* [npm fund](/commands/fund)
* [npm link](/commands/link)
* [npm rebuild](/commands/rebuild)
* [npm update](/commands/npm-update)
* [npm audit](/commands/npm-audit)
* [npm fund](/commands/npm-fund)
* [npm link](/commands/npm-link)
* [npm rebuild](/commands/npm-rebuild)
* [npm scripts](/using-npm/scripts)
* [npm build](/commands/build)
* [npm config](/commands/config)
* [npm build](/commands/npm-build)
* [npm config](/commands/npm-config)
* [npmrc](/configuring-npm/npmrc)
* [npm registry](/using-npm/registry)
* [npm dist-tag](/commands/dist-tag)
* [npm uninstall](/commands/uninstall)
* [npm shrinkwrap](/commands/shrinkwrap)
* [npm dist-tag](/commands/npm-dist-tag)
* [npm uninstall](/commands/npm-uninstall)
* [npm shrinkwrap](/commands/npm-shrinkwrap)
* [package.json](/configuring-npm/package-json)
* [workspaces](/using-npm/workspaces)
4 changes: 2 additions & 2 deletions docs/content/commands/npm-link.md
Expand Up @@ -82,7 +82,7 @@ npm link @myorg/privatepackage

* [npm developers](/using-npm/developers)
* [package.json](/configuring-npm/package-json)
* [npm- nstall](/commands/install)
* [npm- nstall](/commands/npm-install)
* [npm folders](/configuring-npm/folders)
* [npm config](/commands/config)
* [npm config](/commands/npm-config)
* [npmrc](/configuring-npm/npmrc)
6 changes: 3 additions & 3 deletions docs/content/commands/npm-logout.md
Expand Up @@ -44,7 +44,7 @@ npm logout --scope=@myco

### See Also

* [npm adduser](/commands/adduser)
* [npm adduser](/commands/npm-adduser)
* [npm registry](/using-npm/registry)
* [npm config](/commands/config)
* [npm whoami](/commands/whoami)
* [npm config](/commands/npm-config)
* [npm whoami](/commands/npm-whoami)
14 changes: 7 additions & 7 deletions docs/content/commands/npm-ls.md
Expand Up @@ -115,12 +115,12 @@ Set it to false in order to use all-ansi output.

### See Also

* [npm config](/commands/config)
* [npm config](/commands/npm-config)
* [npmrc](/configuring-npm/npmrc)
* [npm folders](/configuring-npm/folders)
* [npm explain](/commands/explain)
* [npm install](/commands/install)
* [npm link](/commands/link)
* [npm prune](/commands/prune)
* [npm outdated](/commands/outdated)
* [npm update](/commands/update)
* [npm explain](/commands/npm-explain)
* [npm install](/commands/npm-install)
* [npm link](/commands/npm-link)
* [npm prune](/commands/npm-prune)
* [npm outdated](/commands/npm-outdated)
* [npm update](/commands/npm-update)
4 changes: 2 additions & 2 deletions docs/content/commands/npm-outdated.md
Expand Up @@ -113,7 +113,7 @@ Display all outdated dependencies on the tree.

### See Also

* [npm update](/commands/update)
* [npm dist-tag](/commands/dist-tag)
* [npm update](/commands/npm-update)
* [npm dist-tag](/commands/npm-dist-tag)
* [npm registry](/using-npm/registry)
* [npm folders](/configuring-npm/folders)
4 changes: 2 additions & 2 deletions docs/content/commands/npm-owner.md
Expand Up @@ -38,7 +38,7 @@ with `--otp`.

### See Also

* [npm publish](/commands/publish)
* [npm publish](/commands/npm-publish)
* [npm registry](/using-npm/registry)
* [npm adduser](/commands/adduser)
* [npm adduser](/commands/npm-adduser)
* [npm disputes](/using-npm/disputes)
6 changes: 3 additions & 3 deletions docs/content/commands/npm-pack.md
Expand Up @@ -28,7 +28,7 @@ actually packing anything. Reports on what would have gone into the tarball.

### See Also

* [npm cache](/commands/cache)
* [npm publish](/commands/publish)
* [npm config](/commands/config)
* [npm cache](/commands/npm-cache)
* [npm publish](/commands/npm-publish)
* [npm config](/commands/npm-config)
* [npmrc](/configuring-npm/npmrc)
2 changes: 1 addition & 1 deletion docs/content/commands/npm-ping.md
Expand Up @@ -25,5 +25,5 @@ Ping error: {*Detail about error}

### See Also

* [npm config](/commands/config)
* [npm config](/commands/npm-config)
* [npmrc](/configuring-npm/npmrc)
8 changes: 4 additions & 4 deletions docs/content/commands/npm-prefix.md
Expand Up @@ -17,12 +17,12 @@ to contain a `package.json` file or `node_modules` directory, unless `-g` is
also specified.

If `-g` is specified, this will be the value of the global prefix. See
[`npm config`](/commands/config) for more detail.
[`npm config`](/commands/npm-config) for more detail.

### See Also

* [npm root](/commands/root)
* [npm bin](/commands/bin)
* [npm root](/commands/npm-root)
* [npm bin](/commands/npm-bin)
* [npm folders](/configuring-npm/folders)
* [npm config](/commands/config)
* [npm config](/commands/npm-config)
* [npmrc](/configuring-npm/npmrc)

0 comments on commit 47a42bd

Please sign in to comment.