Update user guide to add how to handle permission issue
#364
Conversation
| @@ -57,6 +57,9 @@ the different pieces: | |||
| * [Connectors](#connectors) | |||
| * [Formatters](#formatters) | |||
|
|
|||
| ## Permission Issue | |||
There was a problem hiding this comment.
Add empty line after this line
(see also: https://travis-ci.org/sonarwhal/sonar/jobs/250504088#L2417)
There was a problem hiding this comment.
@alrra Done. One question - some links can get quite long in markdown. Do we always have to use inline links? Referenced links seem to work better in those situations.
There was a problem hiding this comment.
some links can get quite long in markdown
Yes, that's why I said "were possible try to keep the length..."
Referenced links seem to work better in those situations.
Can you give an example on how that would look like? Thanks!
There was a problem hiding this comment.
@alrra in the actual text part
...the recommended
solution is to [change npm's default directory][1] and then try again...
and then append the following at the end of the markdown
[1]:https://docs.npmjs.com/getting-started/fixing-npm-permissions#option-2-change-npms-default-directory-to-another-directory
There was a problem hiding this comment.
@qzhou1607 If there are no problems when converting it to HTML, I'm ok with that.
@sonarwhal/contributors Other opinions?
There was a problem hiding this comment.
@alrra checked in Hexo, looks okay. I've pushed up the changes.
docs/user-guide/index.md
Outdated
| @@ -57,6 +57,9 @@ the different pieces: | |||
| * [Connectors](#connectors) | |||
| * [Formatters](#formatters) | |||
|
|
|||
| ## Permission Issue | |||
| If you receive an `EACCES` error when installing `sonar`, the recommended solution is to [change npm's default directory](https://docs.npmjs.com/getting-started/fixing-npm-permissions#option-2-change-npms-default-directory-to-another-directory) and then try again. So far, one such permission issue has been reported when user tries to install `sonar` on [Windows Subsystem for Linux](https://msdn.microsoft.com/en-us/commandline/wsl/install_guide). Dependency `canvas-prebuilt` throws an `EACCES` error during the installation process, and this [issue](https://github.com/sonarwhal/sonar/issues/308) was resolved adopting the recommended solution. You can find detailed steps on how to change the npm default directory [here](https://docs.npmjs.com/getting-started/fixing-npm-permissions#option-2-change-npms-default-directory-to-another-directory). | |||
There was a problem hiding this comment.
Split this line into multiple shorter lines, and were possible try to keep the length of the lines to under 80 characters.
qzhou1607-zz
force-pushed
the
improve_user_guide
branch
from
b0a695d
to
706c194
Compare
docs/user-guide/index.md
Outdated
| `canvas-prebuilt` throws an `EACCES` error during the installation process, | ||
| and this [issue](https://github.com/sonarwhal/sonar/issues/308) was resolved | ||
| adopting the recommended solution. You can find detailed steps on how to change | ||
| the npm default directory [here](https://docs.npmjs.com/getting-started/fixing-npm-permissions#option-2-change-npms-default-directory-to-another-directory). |
There was a problem hiding this comment.
So maybe it is only something that happens if you use the official installer?
There was a problem hiding this comment.
@molant Added more information.
qzhou1607-zz
force-pushed
the
improve_user_guide
branch
from
706c194
to
70c9397
Compare
Fix sonarwhal/sonarwhal.com/webhintio#364
Fix #325