Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

correct the version of node required #215

Merged
merged 5 commits into from
Oct 8, 2020
Merged

correct the version of node required #215

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5fcd06a
correct the version of node required
jeffmcaffer Oct 7, 2020
f695b12
clarify Node.js 12 and 14 requirements and enviroments
zeke Oct 8, 2020
73564d1
12 or 14
zeke Oct 8, 2020
ec859c4
Merge branch 'main' into jeffmcaffer-patch-1
zeke Oct 8, 2020
d488e9a
Merge branch 'main' into jeffmcaffer-patch-1
zeke Oct 8, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions contributing/development.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This site is powered by Node.js! :sparkles: :turtle: :rocket: :sparkles:

It runs on macOS, Windows, and Linux environments.

You'll need **Node.js v14** to run the site. If you're using [`nodenv`](https://github.com/nodenv/nodenv), read the [`nodenv` docs](#nodenv) for instructions on switching Node.js versions. If you're not using `nodenv`, the best way to install Node.js is to [download the LTS installer from nodejs.org](https://nodejs.org).
You'll need Node.js version 12 or 14 to run the site. To install Node.js, [download the "LTS" installer from nodejs.org](https://nodejs.org). If you're using [`nodenv`](https://github.com/nodenv/nodenv), read the [`nodenv` docs](#nodenv) for instructions on switching Node.js versions.

Once you've installed Node.js (which includes the popular `npm` package manager), open Terminal and run the following:

Expand Down Expand Up @@ -52,4 +52,4 @@ For more info about working with this site, check out these READMEs:
- [middleware/README.md](../middleware/README.md)
- [script/README.md](../script/README.md)
- [stylesheets/README.md](../stylesheets/README.md)
- [tests/README.md](../tests/README.md)
- [tests/README.md](../tests/README.md)
4 changes: 3 additions & 1 deletion contributing/node-versions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Node Versions

The site currently runs on Node.js v14, the [Active LTS version](https://nodejs.org/en/about/releases/) from 2020-10-27 to 2021-10-26.
In [development](contributing/development.md) enviroments this site will run on Node.js versions `12 - 14`.

In [staging and production](contributing/deployments.md) environments this site runs on Node.js 14, the [Active LTS version](https://nodejs.org/en/about/releases/) from 2020-10-27 to 2021-10-26).
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's a bit odd to say that Node 14 is the Active LTS when it's not. Perhaps just remove the qualification and say "this site runs on the latest in the Node.js 14 family" (or Node.js 14.* as undoubtedly there will be a gap between a new 14.* coming out and us deploying).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not the Active LTS now, but it will be in 3 weeks. Hence the from 2020-10-27 to 2021-10-26.


When updating to a new Node.js version, consider the following files:

Expand Down