Skip to content
This repository has been archived by the owner. It is now read-only.
Permalink
Browse files
docs: replace references to the old repo or issue tracker (#5)
  • Loading branch information
zkat committed Jul 12, 2018
1 parent 4c32413 commit f0a372b074cc43ee0e1be28dbbcef0d556b3b36c
Showing with 43 additions and 245 deletions.
  1. +2 −2 CONTRIBUTING.md
  2. +1 −1 README.md
  3. +0 −192 TROUBLESHOOTING.md
  4. +1 −1 bin/npm-cli.js
  5. +8 −8 doc/cli/npm-install.md
  6. +15 −25 doc/cli/npm.md
  7. +13 −13 doc/files/package.json.md
  8. +1 −1 doc/misc/npm-disputes.md
  9. +2 −2 package.json
@@ -59,15 +59,15 @@ Collaborators who become inactive for 3 months or longer may have their collabor
* Only answer questions when they know the answer, and provide a reference to the answer.
* If collaborators aren't totally confident about their answer, please leave the issue and try another one.
* If they've responded to an issue, it becomes their responsibility to see it to resolution.
* Close issues if there's no response within a month.
* Defer to fellow Collaborators & npm employees for answers (Again, please don't @ collaborators or npm employees, thank you!)
* Make sure to search for [the troubleshooting doc](./TROUBLESHOOTING.md) and search on the issue tracker for similar issues before opening a new one.
* Make sure to search [the troubleshooting posts on npm.community](https://npm.community/c/support/troubleshooting) and search the rest of the forum for similar topics.

### npm, Inc Employees

Folks who work at npm, Inc, who have a responsibility to ensure the stability and functionality of the tools npm offers.

#### Abilities

* Label/triage new issues
* Respond to ongoing issues
* Close resolved issues
@@ -153,7 +153,7 @@ you should [read this](https://docs.npmjs.com/misc/developers).
When you find issues, please report them:

* web:
<https://github.com/npm/npm/issues>
<https://npm.community/c/bugs>

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.

This file was deleted.

@@ -103,7 +103,7 @@
break
}
}
const changelog = `https://github.com/npm/npm/releases/tag/v${latest}`
const changelog = `https://github.com/npm/cli/releases/tag/v${latest}`
notifier.notify({
message: `New ${type} version of ${pkg.name} available! ${
useColor ? color.red(old) : old
@@ -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>]`:
@@ -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

0 comments on commit f0a372b

Please sign in to comment.