Skip to content

Commit

Permalink
docs: change command links to /commands
Browse files Browse the repository at this point in the history
These links now reflect the reality of the filesystem and their paths.
  • Loading branch information
ethomson authored and isaacs committed Oct 23, 2020
1 parent 09ca74c commit 6522365
Show file tree
Hide file tree
Showing 72 changed files with 248 additions and 248 deletions.
6 changes: 3 additions & 3 deletions Makefile
Expand Up @@ -6,9 +6,9 @@ BRANCH = $(shell git rev-parse --abbrev-ref HEAD)

markdowns = $(shell find docs -name '*.md' | grep -v 'index') README.md

cli_mandocs = $(shell find docs/content/cli-commands -name '*.md' \
cli_mandocs = $(shell find docs/content/commands -name '*.md' \
|sed 's|.md|.1|g' \
|sed 's|docs/content/cli-commands/|man/man1/|g' ) \
|sed 's|docs/content/commands/|man/man1/|g' ) \
man/man1/npm-README.1

files_mandocs = $(shell find docs/content/configuring-npm -name '*.md' \
Expand Down Expand Up @@ -79,7 +79,7 @@ man/man1/npm-README.1: README.md scripts/docs-build.js package.json $(build-doc-
@[ -d man/man1 ] || mkdir -p man/man1
node scripts/docs-build.js $< $@

man/man1/%.1: docs/content/cli-commands/%.md scripts/docs-build.js package.json $(build-doc-tools)
man/man1/%.1: docs/content/commands/%.md scripts/docs-build.js package.json $(build-doc-tools)
@[ -d man/man1 ] || mkdir -p man/man1
node scripts/docs-build.js $< $@

Expand Down
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](/cli-commands/team)
* [npm publish](/cli-commands/publish)
* [npm config](/cli-commands/config)
* [npm team](/commands/team)
* [npm publish](/commands/publish)
* [npm config](/commands/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](/cli-commands/config)
* [npm config](/commands/config)
* [npmrc](/configuring-npm/npmrc)
* [npm owner](/cli-commands/owner)
* [npm whoami](/cli-commands/whoami)
* [npm owner](/commands/owner)
* [npm whoami](/commands/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](/cli-commands/install)
* [npm install](/commands/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](/cli-commands/prefix)
* [npm root](/cli-commands/root)
* [npm prefix](/commands/prefix)
* [npm root](/commands/root)
* [npm folders](/configuring-npm/folders)
* [npm config](/cli-commands/config)
* [npm config](/commands/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](/cli-commands/docs)
* [npm view](/cli-commands/view)
* [npm publish](/cli-commands/publish)
* [npm docs](/commands/docs)
* [npm view](/commands/view)
* [npm publish](/commands/publish)
* [npm registry](/using-npm/registry)
* [npm config](/cli-commands/config)
* [npm config](/commands/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](/cli-commands/config)
* [npm config](/commands/config)
* [npmrc](/configuring-npm/npmrc)
* [npm install](/cli-commands/install)
* [npm publish](/cli-commands/publish)
* [npm pack](/cli-commands/pack)
* [npm install](/commands/install)
* [npm publish](/commands/publish)
* [npm pack](/commands/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](/cli-commands/install)
* [npm install](/commands/install)
* [package-locks](/configuring-npm/package-locks)
2 changes: 1 addition & 1 deletion docs/content/commands/npm-completion.md
Expand Up @@ -36,4 +36,4 @@ completions based on the arguments.
### See Also

* [npm developers](/using-npm/developers)
* [npm](/cli-commands/npm)
* [npm](/commands/npm)
4 changes: 2 additions & 2 deletions docs/content/commands/npm-config.md
Expand Up @@ -83,7 +83,7 @@ global config.
### See Also

* [npm folders](/configuring-npm/folders)
* [npm config](/cli-commands/config)
* [npm config](/commands/config)
* [package.json](/configuring-npm/package-json)
* [npmrc](/configuring-npm/npmrc)
* [npm](/cli-commands/npm)
* [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](/cli-commands/publish)
* [npm publish](/commands/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](/cli-commands/publish)
* [npm install](/cli-commands/install)
* [npm dedupe](/cli-commands/dedupe)
* [npm publish](/commands/publish)
* [npm install](/commands/install)
* [npm dedupe](/commands/dedupe)
* [npm registry](/using-npm/registry)
* [npm config](/cli-commands/config)
* [npm config](/commands/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](/cli-commands/view)
* [npm publish](/cli-commands/publish)
* [npm view](/commands/view)
* [npm publish](/commands/publish)
* [npm registry](/using-npm/registry)
* [npm config](/cli-commands/config)
* [npm config](/commands/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](/cli-commands/bugs)
* [npm help](/cli-commands/help)
* [npm ping](/cli-commands/ping)
* [npm bugs](/commands/bugs)
* [npm help](/commands/help)
* [npm ping](/commands/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](/cli-commands/explore)
* [npm install](/cli-commands/install)
* [npm config](/cli-commands/config)
* [npm explore](/commands/explore)
* [npm install](/commands/install)
* [npm config](/commands/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](/cli-commands/run-script)
* [npm run-script](/commands/run-script)
* [npm scripts](/using-npm/scripts)
* [npm test](/cli-commands/test)
* [npm start](/cli-commands/start)
* [npm restart](/cli-commands/restart)
* [npm stop](/cli-commands/stop)
* [npm config](/cli-commands/config)
* [npm test](/commands/test)
* [npm start](/commands/start)
* [npm restart](/commands/restart)
* [npm stop](/commands/stop)
* [npm config](/commands/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](/cli-commands/config)
* [npm config](/commands/config)
* [npmrc](/configuring-npm/npmrc)
* [npm folders](/configuring-npm/folders)
* [npm ls](/cli-commands/ls)
* [npm install](/cli-commands/install)
* [npm link](/cli-commands/link)
* [npm prune](/cli-commands/prune)
* [npm outdated](/cli-commands/outdated)
* [npm update](/cli-commands/update)
* [npm ls](/commands/ls)
* [npm install](/commands/install)
* [npm link](/commands/link)
* [npm prune](/commands/prune)
* [npm outdated](/commands/outdated)
* [npm update](/commands/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](/cli-commands/edit)
* [npm rebuild](/cli-commands/rebuild)
* [npm build](/cli-commands/build)
* [npm install](/cli-commands/install)
* [npm edit](/commands/edit)
* [npm rebuild](/commands/rebuild)
* [npm build](/commands/build)
* [npm install](/commands/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 docs](/cli-commands/docs)
* [npm config](/cli-commands/config)
* [npm install](/cli-commands/install)
* [npm ls](/cli-commands/ls)
* [npm install](/commands/install)
* [npm docs](/commands/docs)
* [npm ls](/commands/ls)
* [npm config](/commands/config)
4 changes: 2 additions & 2 deletions docs/content/commands/npm-help-search.md
Expand Up @@ -35,5 +35,5 @@ If false, then help-search will just list out the help topics found.

### See Also

* [npm](/cli-commands/npm)
* [npm help](/cli-commands/help)
* [npm](/commands/npm)
* [npm help](/commands/help)
6 changes: 3 additions & 3 deletions docs/content/commands/npm-help.md
Expand Up @@ -32,9 +32,9 @@ Set to `"browser"` to view html help content in the default web browser.

### See Also

* [npm](/cli-commands/npm)
* [npm](/commands/npm)
* [npm folders](/configuring-npm/folders)
* [npm config](/cli-commands/config)
* [npm config](/commands/config)
* [npmrc](/configuring-npm/npmrc)
* [package.json](/configuring-npm/package-json)
* [npm help-search](/cli-commands/help-search)
* [npm help-search](/commands/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](/cli-commands/version)
* [npm version](/commands/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](/cli-commands/install-test)
* [npm ci](/cli-commands/ci)
* [npm test](/cli-commands/test)
* [npm install-test](/commands/install-test)
* [npm ci](/commands/ci)
* [npm test](/commands/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](/cli-commands/install)
* [npm install-ci-test](/cli-commands/install-ci-test)
* [npm test](/cli-commands/test)
* [npm install](/commands/install)
* [npm install-ci-test](/commands/install-ci-test)
* [npm test](/commands/test)
28 changes: 14 additions & 14 deletions docs/content/commands/npm-install.md
Expand Up @@ -35,7 +35,7 @@ following order of precedence:
* `yarn.lock`

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

A `package` is:

Expand All @@ -45,7 +45,7 @@ A `package` is:
* 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`](/cli-commands/dist-tag)) that
* e) a `<name>@<tag>` (see [`npm dist-tag`](/commands/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 @@ -88,7 +88,7 @@ into a tarball (b).

Install a package that is sitting on the filesystem. Note: if you just
want to link a dev directory into your npm root, you can do this more
easily by using [`npm link`](/cli-commands/npm-link).
easily by using [`npm link`](/commands/npm-link).

Tarball requirements:
* The filename *must* use `.tar`, `.tar.gz`, or `.tgz` as the
Expand Down Expand Up @@ -487,7 +487,7 @@ Legacy shorthands for `omit` settings are:
* `--no-fund`: suppress the message displayed at the end of each install
that acknowledges the number of dependencies looking for funding. See
[`npm-fund`](/cli-commands/npm-fund)
[`npm-fund`](/commands/npm-fund)
* `--dry-run`: Do not actually install anything into the `node_modules`
folder. Just build the intended tree in memory, and report on it.
Expand Down Expand Up @@ -532,18 +532,18 @@ the specific folder structures that npm creates.
### See Also
* [npm folders](/configuring-npm/folders)
* [npm update](/cli-commands/update)
* [npm audit](/cli-commands/audit)
* [npm fund](/cli-commands/fund)
* [npm link](/cli-commands/link)
* [npm rebuild](/cli-commands/rebuild)
* [npm update](/commands/update)
* [npm audit](/commands/audit)
* [npm fund](/commands/fund)
* [npm link](/commands/link)
* [npm rebuild](/commands/rebuild)
* [npm scripts](/using-npm/scripts)
* [npm build](/cli-commands/build)
* [npm config](/cli-commands/config)
* [npm build](/commands/build)
* [npm config](/commands/config)
* [npmrc](/configuring-npm/npmrc)
* [npm registry](/using-npm/registry)
* [npm dist-tag](/cli-commands/dist-tag)
* [npm uninstall](/cli-commands/uninstall)
* [npm shrinkwrap](/cli-commands/shrinkwrap)
* [npm dist-tag](/commands/dist-tag)
* [npm uninstall](/commands/uninstall)
* [npm shrinkwrap](/commands/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](/cli-commands/install)
* [npm- nstall](/commands/install)
* [npm folders](/configuring-npm/folders)
* [npm config](/cli-commands/config)
* [npm config](/commands/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](/cli-commands/adduser)
* [npm adduser](/commands/adduser)
* [npm registry](/using-npm/registry)
* [npm config](/cli-commands/config)
* [npm whoami](/cli-commands/whoami)
* [npm config](/commands/config)
* [npm whoami](/commands/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](/cli-commands/config)
* [npm config](/commands/config)
* [npmrc](/configuring-npm/npmrc)
* [npm folders](/configuring-npm/folders)
* [npm explain](/cli-commands/explain)
* [npm install](/cli-commands/install)
* [npm link](/cli-commands/link)
* [npm prune](/cli-commands/prune)
* [npm outdated](/cli-commands/outdated)
* [npm update](/cli-commands/update)
* [npm explain](/commands/explain)
* [npm install](/commands/install)
* [npm link](/commands/link)
* [npm prune](/commands/prune)
* [npm outdated](/commands/outdated)
* [npm update](/commands/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](/cli-commands/update)
* [npm dist-tag](/cli-commands/dist-tag)
* [npm update](/commands/update)
* [npm dist-tag](/commands/dist-tag)
* [npm registry](/using-npm/registry)
* [npm folders](/configuring-npm/folders)

0 comments on commit 6522365

Please sign in to comment.