correct the version of node required #215
Conversation
| 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). |
There was a problem hiding this comment.
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).
There was a problem hiding this comment.
It's not the Active LTS now, but it will be in 3 weeks. Hence the from 2020-10-27 to 2021-10-26.
contributing/development.md
Outdated
| @@ -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 - 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. | |||
There was a problem hiding this comment.
consider using non-technical terms to talk about the versions. For example, for people not familiar with the Node versioning scheme, 12 - 14 could look like an actual version number. Whereas what I think you mean is "any stable version from 12 on".
There was a problem hiding this comment.
I chose the literal 12 - 14 string because it's explicit. I can change that to "Node.js versions 12 to 14`
We don't actually mean "any stable version from 12 on". If anyone tries to run the site on something greater than Node 14, it won't run.
|
@jeffmcaffer I tweaked the wording based on your suggestions. Gonna ship this when it turns green. |
|
Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you haven't already, you can add yourself to the list of contributors by creating a new comment in this PR using these instructions. Thanks again! ✨ |
* New issues from Moz, plus some general tidy-up * Issue github#222 * Issue github#215 & remove unused links * Others from Moz * Moar 404s, syntax, etc. * make fixing changes to links Co-authored-by: Miranda Auhl <miranda@timescale.com> Co-authored-by: Ryan Booz <ryan@timescale.com>
Why:
stated version of node was 14 when it's actually 12
What's being changed:
fix the doc
Check off the following: