diff options
author | Tomi Carr <TaMe3971@users.noreply.github.com> | 2015-10-18 19:28:56 +0300 |
---|---|---|
committer | Rebecca Turner <me@re-becca.org> | 2015-10-22 01:19:14 +0300 |
commit | 291162c086f09155cd82663734c62a2598a10c87 (patch) | |
tree | d408f208f893483c34f2dfb38104a3bb3199e50c /doc | |
parent | 9a28c548e3fc01d72ae4f79dc6a173ab6870d82b (diff) |
doc: Improve wording in the FAQ to be more empathic and less jokey
PR-URL: https://github.com/npm/npm/pull/10021
Diffstat (limited to 'doc')
-rw-r--r-- | doc/misc/npm-faq.md | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/doc/misc/npm-faq.md b/doc/misc/npm-faq.md index 557ec1a9c..cc1c19e61 100644 --- a/doc/misc/npm-faq.md +++ b/doc/misc/npm-faq.md @@ -7,18 +7,19 @@ npm-faq(7) -- Frequently Asked Questions npm config set viewer browser -to open these documents in your default web browser rather than `man`. +This command will set the npm docs to open in your default web browser rather than `man`. ## It didn't work. -That's not really a question. +Please provide a little more detail, search for the error via [Google](https://google.com) or [StackOverflow npm](http://stackoverflow.com/search?q=npm) to see if another developer has encountered a similar problem. ## Why didn't it work? I don't know yet. -Read the error output, and if you can't figure out what it means, -do what it says and post a bug with all the information it asks for. +Try reading the error output first, ensure this is a true npm issue and not a package issue. If you are having an issue with a package dependency, please submit your error to that particular package maintainer. + +For any npm issues, try following the instructions, or even retracing your steps. If the issue continues to persist, submit a bug with the steps to reproduce, please include the operating system you are working on, along with the error you recieve. ## Where does npm put stuff? @@ -28,7 +29,7 @@ tl;dr: * Use the `npm root` command to see where modules go, and the `npm bin` command to see where executables go -* Global installs are different from local installs. If you install +* Global installs are different from local installs. If you install something with the `-g` flag, then its executables go in `npm bin -g` and its modules go in `npm root -g`. |