Skip to content
This repository has been archived by the owner on Feb 22, 2023. It is now read-only.

Add instructions to use volta to install node in the READMe #2038

Closed
1 task
sarayourfriend opened this issue Dec 9, 2022 · 2 comments · Fixed by #2040
Closed
1 task

Add instructions to use volta to install node in the READMe #2038

sarayourfriend opened this issue Dec 9, 2022 · 2 comments · Fixed by #2040
Labels
📄 aspect: text Concerns the textual material in the repository ✨ goal: improvement Improvement to an existing user-facing feature 🟨 priority: medium Not blocking but should be addressed soon

Comments

@sarayourfriend
Copy link
Contributor

Problem

We've gotten at least two newer contributors confused about which Node version to use. We pin the node version using Volta, but do not specifically direct the reader of the README to initialise volta in the repository. This seems to be a gap in the assumptions of what we think people will know on their own.

Description

Add a new bit to the README before the pnpm installation instructions to run volta install node@16.15.0. I believe there's a way to get volta to automatically install Node at the pinned version (I thought that was the entire point) but I haven't found it in the docs yet and I don't have time right now to research it further. If whoever is working on this can figure that out, make sure the instructions specify to follow that method. Maybe it has something to do with using volta run pnpm dev instead of volta run pnpm? Additionally, we should add to check the package.json volta pinned version to see which version of Node the project currently expects (if that is indeed our canonical node version for the project).

Alternatives

Additional context

Implementation

  • 🙋 I would be interested in implementing this feature.
@sarayourfriend sarayourfriend added 🟨 priority: medium Not blocking but should be addressed soon ✨ goal: improvement Improvement to an existing user-facing feature 📄 aspect: text Concerns the textual material in the repository labels Dec 9, 2022
@rajdeepdas2000
Copy link
Contributor

Raised PR #2040 addressing this issue, kindly review it. Thanks

@zackkrida
Copy link
Member

I wrote a bit about how volta works here:

Volta automatically symlinks the correct node version, but it only does its check to create the correct symlink the first time node or npm is evoked in a directory. So if someone has volta installed, clones the frontend, and runs a command like node -v in the repo root, at that point volta will automatically install and symlink node v16.15.0 before evoking the command.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
📄 aspect: text Concerns the textual material in the repository ✨ goal: improvement Improvement to an existing user-facing feature 🟨 priority: medium Not blocking but should be addressed soon
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants