Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/npm/cli.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorKat Marchán <kzm@zkat.tech>2018-07-13 02:21:29 +0300
committerGitHub <noreply@github.com>2018-07-13 02:21:29 +0300
commitf0a372b074cc43ee0e1be28dbbcef0d556b3b36c (patch)
tree8ea0da08e6b76308f8cf8928e6b3ffae6c5f994d /doc
parent4c32413a5b42e18a34afb078cf00eed60f08e4ff (diff)
docs: replace references to the old repo or issue tracker (#5)
Diffstat (limited to 'doc')
-rw-r--r--doc/cli/npm-install.md16
-rw-r--r--doc/cli/npm.md40
-rw-r--r--doc/files/package.json.md26
-rw-r--r--doc/misc/npm-disputes.md2
4 files changed, 37 insertions, 47 deletions
diff --git a/doc/cli/npm-install.md b/doc/cli/npm-install.md
index 7eb8608a8..a349e5862 100644
--- a/doc/cli/npm-install.md
+++ b/doc/cli/npm-install.md
@@ -54,7 +54,7 @@ after packing it up into a tarball (b).
With the `--production` flag (or when the `NODE_ENV` environment variable
is set to `production`), npm will not install modules listed in
`devDependencies`.
-
+
> NOTE: The `--production` flag has no particular meaning when adding a
dependency to a project.
@@ -69,8 +69,8 @@ after packing it up 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`.
-
+ using `npm link`.
+
Tarball requirements:
* The filename *must* use `.tar`, `.tar.gz`, or `.tgz` as
the extension.
@@ -223,11 +223,11 @@ after packing it up into a tarball (b).
Examples:
- npm install git+ssh://git@github.com:npm/npm.git#v1.0.27
- npm install git+ssh://git@github.com:npm/npm#semver:^5.0
- npm install git+https://isaacs@github.com/npm/npm.git
- npm install git://github.com/npm/npm.git#v1.0.27
- GIT_SSH_COMMAND='ssh -i ~/.ssh/custom_ident' npm install git+ssh://git@github.com:npm/npm.git
+ npm install git+ssh://git@github.com:npm/cli.git#v1.0.27
+ npm install git+ssh://git@github.com:npm/cli#semver:^5.0
+ npm install git+https://isaacs@github.com/npm/cli.git
+ npm install git://github.com/npm/cli.git#v1.0.27
+ GIT_SSH_COMMAND='ssh -i ~/.ssh/custom_ident' npm install git+ssh://git@github.com:npm/cli.git
* `npm install <githubname>/<githubrepo>[#<commit-ish>]`:
* `npm install github:<githubname>/<githubrepo>[#<commit-ish>]`:
diff --git a/doc/cli/npm.md b/doc/cli/npm.md
index e41e7252e..82f78a0f9 100644
--- a/doc/cli/npm.md
+++ b/doc/cli/npm.md
@@ -53,10 +53,10 @@ See `npm-folders(5)` to learn about where npm puts stuff.
In particular, npm has two modes of operation:
-* global mode:
+* global mode:
npm installs packages into the install prefix at
`prefix/lib/node_modules` and bins are installed in `prefix/bin`.
-* local mode:
+* local mode:
npm installs packages into the current project directory, which
defaults to the current working directory. Packages are installed to
`./node_modules`, and bins are installed to `./node_modules/.bin`.
@@ -90,24 +90,24 @@ following help topics:
npm is extremely configurable. It reads its configuration options from
5 places.
-* Command line switches:
+* Command line switches:
Set a config with `--key val`. All keys take a value, even if they
are booleans (the config parser doesn't know what the options are at
the time of parsing). If no value is provided, then the option is set
to boolean `true`.
-* Environment Variables:
+* Environment Variables:
Set any config by prefixing the name in an environment variable with
`npm_config_`. For example, `export npm_config_key=val`.
-* User Configs:
+* User Configs:
The file at $HOME/.npmrc is an ini-formatted list of configs. If
present, it is parsed. If the `userconfig` option is set in the cli
or env, then that will be used instead.
-* Global Configs:
+* Global Configs:
The file found at ../etc/npmrc (from the node executable, by default
this resolves to /usr/local/etc/npmrc) will be parsed if it is found.
If the `globalconfig` option is set in the cli, env, or user config,
then that file is parsed instead.
-* Defaults:
+* Defaults:
npm's default configuration options are defined in
lib/utils/config-defs.js. These must not be changed.
@@ -117,34 +117,24 @@ See `npm-config(7)` for much much more information.
Patches welcome!
-* code:
- Read through `npm-coding-style(7)` if you plan to submit code.
- You don't have to agree with it, but you do have to follow it.
-* docs:
- If you find an error in the documentation, edit the appropriate markdown
- file in the "doc" folder. (Don't worry about generating the man page.)
-
-Contributors are listed in npm's `package.json` file. You can view them
-easily by doing `npm view npm contributors`.
-
If you would like to contribute, but don't know what to work on, read
the contributing guidelines and check the issues list.
-* https://github.com/npm/npm/wiki/Contributing-Guidelines
-* <https://github.com/npm/npm/issues>
+* [CONTRIBUTING.md](https://github.com/npm/cli/blob/latest/CONTRIBUTING.md)
+* [Bug tracker](https://npm.community/c/bugs)
+* [Support tracker](https://npm.community/c/support)
## BUGS
When you find issues, please report them:
* web:
- <https://github.com/npm/npm/issues>
-
-Be sure to include *all* of the output from the npm command that didn't work
-as expected. The `npm-debug.log` file is also helpful to provide.
+ <https://npm.community/c/bugs>
-You can also look for isaacs in #node.js on irc://irc.freenode.net. He
-will no doubt tell you to put the output in a gist or email.
+Be sure to follow the template and bug reporting guidelines. You can also ask
+for help in the [support forum](https://npm.community/c/support) if you're
+unsure if it's actually a bug or are having trouble coming up with a detailed
+reproduction to report.
## AUTHOR
diff --git a/doc/files/package.json.md b/doc/files/package.json.md
index 9fa17f746..d1fbe5254 100644
--- a/doc/files/package.json.md
+++ b/doc/files/package.json.md
@@ -11,10 +11,10 @@ settings described in `npm-config(7)`.
## name
-If you plan to publish your package, the *most* important things in your
-package.json are the name and version fields as they will be required. The name
-and version together form an identifier that is assumed to be completely unique.
-Changes to the package should come along with changes to the version. If you don't
+If you plan to publish your package, the *most* important things in your
+package.json are the name and version fields as they will be required. The name
+and version together form an identifier that is assumed to be completely unique.
+Changes to the package should come along with changes to the version. If you don't
plan to publish your package, the name and version fields are optional.
The name is what your thing is called.
@@ -44,10 +44,10 @@ A name can be optionally prefixed by a scope, e.g. `@myorg/mypackage`. See
## version
-If you plan to publish your package, the *most* important things in your
-package.json are the name and version fields as they will be required. The name
-and version together form an identifier that is assumed to be completely unique.
-Changes to the package should come along with changes to the version. If you don't
+If you plan to publish your package, the *most* important things in your
+package.json are the name and version fields as they will be required. The name
+and version together form an identifier that is assumed to be completely unique.
+Changes to the package should come along with changes to the version. If you don't
plan to publish your package, the name and version fields are optional.
Version must be parseable by
@@ -368,7 +368,7 @@ Do it like this:
"repository" :
{ "type" : "git"
- , "url" : "https://github.com/npm/npm.git"
+ , "url" : "https://github.com/npm/cli.git"
}
"repository" :
@@ -490,10 +490,10 @@ specified, then `master` is used.
Examples:
- git+ssh://git@github.com:npm/npm.git#v1.0.27
- git+ssh://git@github.com:npm/npm#semver:^5.0
- git+https://isaacs@github.com/npm/npm.git
- git://github.com/npm/npm.git#v1.0.27
+ git+ssh://git@github.com:npm/cli.git#v1.0.27
+ git+ssh://git@github.com:npm/cli#semver:^5.0
+ git+https://isaacs@github.com/npm/cli.git
+ git://github.com/npm/cli.git#v1.0.27
### GitHub URLs
diff --git a/doc/misc/npm-disputes.md b/doc/misc/npm-disputes.md
index d247cf05b..2d8885ecf 100644
--- a/doc/misc/npm-disputes.md
+++ b/doc/misc/npm-disputes.md
@@ -114,7 +114,7 @@ metadata.
## CHANGES
This is a living document and may be updated from time to time. Please refer to
-the [git history for this document](https://github.com/npm/npm/commits/master/doc/misc/npm-disputes.md)
+the [git history for this document](https://github.com/npm/cli/commits/latest/doc/misc/npm-disputes.md)
to view the changes.
## LICENSE