Skip to content

docs: update macOS install instructions for nvm

Warren Gifford requested to merge mjf-dev-setup into master

Created by: creachadair

Context: Slack thread

Our local development setup recommends installing nvm via Homebrew, and installing NodeJS using nvm install. However, the Homebrew formula for nvm is not supported by the NVM maintainers, and must be configured manually, and the node version installed by brew install node may not be compatible with the current state of the sourcegraph repository.

Update the local setup instructions to more clearly document the necessary steps, so that the setup instructions are more likely to "just work" without additional context.

This includes:

  • Use the recommended nvm installation script from GitHub (rather than Homebrew).
  • Expand the instructions for nvm install to include nvm use (to ensure PATH is updated).
  • Clarify why this is preferred to installing the nvm and node packages directly from Homebrew.

Merge request reports