Point to compiler's install guide #323
Conversation
Boosting heading sizes too so they're slightly larger than bold text.
|
Thanks, but I don't think this should be part of the main getting started guide. I'd prefer a link to the INSTALL.md file in the compiler repo, which covers installation FAQs. |
Does this FAQ need to be created? The motivation for a troubleshooting section here is that we often need to help beginners through EACCES and libtinfo errors on slack. For example, search: Given that lots of users already miss the EACCES note in these instructions, I'm not sure how likely they'll be to find their solution in a linked FAQ. Hoping these prominent error snippets on this same page will help them see the connection. |
|
I don’t understand your question about whether it needs to be created? That INSTALL.md file you linked already covers some common questions and issues that arise for people trying to install the compiler, such as supported OS versions, how to build it from source, and installing ncurses. I don’t think we can assume that people are reading this guide and missing the existing stuff. There are many “getting started” resources out there aside from this one, or people might not even be using any, they might just be running |
|
I think the most effective approach would probably be to get the npm installer to try to identify these issues where they occur and print appropriate error messages. |
I meant whether a specific "FAQ" or "Troubleshooting" section should be created in INSTALL.md to help users more easily identify where to find these solutions.
That's a good point. Perhaps link to these same troubleshooting tips from there too. |
|
I don’t think a separate section called “troubleshooting” or “FAQ” should be created in INSTALL.md, since the focus of the majority of that file is already to help people install the compiler or fix common installation issues. I think including the EACCES error in there too would be a good idea. |
* Add troubleshooting steps for libtinfo and EACCES errors See purescript/documentation#323 (comment) * Absorb `libtinfo` troubleshooting, change "here" link * Separate troubleshooting steps for libtinfo5 * Suggest installing both libtinfo5 and libncurses5-dev
guides/Getting-Started.md
Outdated
|
|
||
| You'll need to install [Node.js and npm](https://docs.npmjs.com/getting-started/installing-node). We recommend installing [Node.js and npm via a node version manager](https://docs.npmjs.com/getting-started/installing-node) to avoid issues with installing packages globally. If you choose to install it manually, you might experience the [`EACCES` error when installing packages globally](https://docs.npmjs.com/getting-started/fixing-npm-permissions#option-1-change-the-permission-to-npm-s-default-directory). | ||
| You'll need to install [Node.js and npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm#using-a-node-version-manager-to-install-nodejs-and-npm). We recommend installing [Node.js and npm via a node version manager](https://docs.npmjs.com/getting-started/installing-node) to avoid issues with installing packages globally. If you choose to install it manually, you might experience the [`EACCES` error when installing packages globally](https://docs.npmjs.com/getting-started/fixing-npm-permissions). |
There was a problem hiding this comment.
Perhaps this could say "We suggest installing the compiler with NPM, though other installation methods exist" and link over to the INSTALL.md file?
There was a problem hiding this comment.
INSTALL.md is linked below for troubleshooting. But I can link to it again in this paragraph. Not sure exactly what would be the best wording here. If you have something specific in-mind, feel free to edit the file in this PR and re-commit to my branch. I believe the github interface makes this easy.
There was a problem hiding this comment.
I originally went with the minimal-change strategy for this section by just adding the correct anchors, but will go ahead with my interpretation of your suggestion.
Removing some content from the getting started guide in favor of linking here (purescript/documentation#323), so this PR ensures that no content is lost.
|
Applied latest review feedback and also simplified the installation instructions by linking to the compiler's INSTALL.md. The removed content is being reintroduced in purescript/purescript#3920 |
milesfrain
changed the title
Boosting heading sizes too so they're slightly larger than bold text.