docs(getting-started): Refer to nvm installation instructions #1080
Conversation
Deploying documentation with
|
| Latest commit: |
a7337f0
|
| Status: | 🚫 Build failed. |
main/guides/getting-started/index.md
Outdated
| In this section you'll be installing prerequisite components into your environment. If you're working with your own environment rather than using a fresh Ubuntu install, you may already have some or all of these components already installed. | ||
|
|
||
| ### Installing NVM and Node | ||
| ### Installing nvm and Node.js |
| export NVM_DIR="$([ -z "${XDG_CONFIG_HOME-}" ] && printf %s "${HOME}/.nvm" || printf %s "${XDG_CONFIG_HOME}/nvm")" | ||
| [ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh" # This loads nvm |
There was a problem hiding this comment.
Is all this gobbledygook necessary? I'm pretty sure @kbennett2000 tested the source ~/.bashrc approach.
There was a problem hiding this comment.
That only works for bash, while Fred was using zsh. But the most important aspect of this change is including the https://github.com/nvm-sh/nvm?tab=readme-ov-file#installing-and-updating link; this block is now just an example for one-stop-shopping and could be removed entirely:
Installing nvm and Node.js on Ubuntu
At this point the nvm (Node Version Manager) utility will be installed.
nvmmakes it easy to select the specific version of Node.js that will be required for this tutorial (v18.16.0).First, follow the nvm installation instructions, including sourcing
nvm.shinto the shell for later steps.Then, install Node.js.
nvm install v18.18.0
There was a problem hiding this comment.
this block ... could be removed entirely
I think the tutorial is designed to be self-contained. Every command you have to issue is on one page. (Installing Keplr might be one exception where some steps are not covered in full.)
Fred was using zsh.
The tutorial is one path through the whole process. I think we try to distinguish requirements (node.js) from the detailed existence proof that they can be met (nvm ...).
There was a problem hiding this comment.
That makes sense, in which case those instructions do have a place. But I've updated to indicate that nvm is a convenient way to satisfy the Node.js requirement rather than a requirement unto itself.
gibson042
force-pushed
the
gibson-1079-installing-nvm
branch
from
c399e4b to
a7337f0
Compare
3 participants
Fixes #1079
Also updates to canonical spelling and capitalization for nvm and Node.js.