Skip to content

Commit

Permalink
Fix links to Spoke and nvm install to .nvmrc version link
Browse files Browse the repository at this point in the history
  • Loading branch information
percworld committed Jan 5, 2022
1 parent 4c03a29 commit 496a8d2
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 7 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ gratitude and appreciation of everyone's time and work.
Generally, the first steps are:

- Fork this repository and clone it on your local. Our main branch is called `main`.
- Get a working development environment (see the [ENVIRONMENT](https://github.com/percworld/Spoke/blob/main/docs/HOWTO_DEVELOPMENT_LOCAL_SETUP.md) to onboard and [DEVELOPMENT TIPS](https://github.com/MoveOnOrg/Spoke/blob/main/docs/EXPLANATION-development-guidelines.md) which is included in the explanation section [docs/](https://github.com/MoveOnOrg/Spoke/tree/main/docs))-- reach out through our communication channels (above) if you have issues.
- Get a working development environment (see the [ENVIRONMENT](https://github.com/MoveOnOrg/Spoke/blob/main/docs/HOWTO_DEVELOPMENT_LOCAL_SETUP.md) to onboard and [DEVELOPMENT TIPS](https://github.com/MoveOnOrg/Spoke/blob/main/docs/EXPLANATION-development-guidelines.md) which is included in the explanation section [docs/](https://github.com/MoveOnOrg/Spoke/tree/main/docs))-- reach out through our communication channels (above) if you have issues.

### Picking an issue

Expand Down
2 changes: 1 addition & 1 deletion docs/EXPLANATION-development-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
This document describes tips and current gotchas in our code base and explains the context
for parts that are evolving in a certain direction (or we *want* to evolve in a certain direction).

See [ENVIRONMENT](https://github.com/percworld/Spoke/blob/main/docs/HOWTO_DEVELOPMENT_LOCAL_SETUP.md) to calibrate your development environment, [DEVELOPMENT TIPS](https://github.com/MoveOnOrg/Spoke/blob/main/docs/EXPLANATION-development-guidelines.md), [CONTRIBUTING](../CONTRIBUTING.md) instructions and an overview about how to help and join in development.
See [ENVIRONMENT](https://github.com/MoveOnOrg/Spoke/blob/main/docs/HOWTO_DEVELOPMENT_LOCAL_SETUP.md) to calibrate your development environment, [DEVELOPMENT TIPS](https://github.com/MoveOnOrg/Spoke/blob/main/docs/EXPLANATION-development-guidelines.md), [CONTRIBUTING](../CONTRIBUTING.md) instructions and an overview about how to help and join in development.
The [README](../README.md) is available for deployment when you are working in production with an organization.

## Documentation Organization
Expand Down
11 changes: 6 additions & 5 deletions docs/HOWTO_DEVELOPMENT_LOCAL_SETUP.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,18 +26,19 @@ git remote add upstream https://github.com/MoveOnOrg/Spoke.git
---
### Downloading

1. Install the Node version listed in `.nvmrc`. [NVM](https://github.com/creationix/nvm) is one way to do this (from the spoke directory):
1. Install the Node version listed in `.nvmrc`. This can also be found here:[.nvmrc](https://github.com/MoveOnOrg/Spoke/blob/main/.nvmrc).
From the spoke directory:
```
nvm install 12
nvm use 12
nvm install
nvm use
```
- this assumes you have nvm (node version manager) installed. If not, either
* run
```
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash
```
* or visit [NVM INTRO](https://github.com/nvm-sh/nvm/blob/master/README.md) for a better understanding.
- at this time of this writing, nvm install will install a version above 17 but we want to run 12 and then yarn will have to be installed again, even if you use yarn already.
* or visit [NVM](https://github.com/nvm-sh/nvm/blob/master/README.md), a great resource for installation if your terminal isn't recognizing nvm or if you'd like more background on these commands.
- at this time of this writing, nvm install will install a version above 17 but we want to run 12. Yarn will have to be installed again, even if you have yarn installed already, as it will need to be compatible with this version of nvm.

2. Install yarn.

Expand Down

0 comments on commit 496a8d2

Please sign in to comment.