Commit 2e232969 authored by Dan Allen's avatar Dan Allen

add references to Why Node 8? section

- reference ADR to provide detail about decision
- reference docs for async function
- minor rewording
parent 69db2506
......@@ -10,7 +10,9 @@
:uri-issue-board: {uri-project}/boards/368796
:uri-issue-labels: {uri-project}/labels
:uri-ci-pipelines: {uri-project}/pipelines
:uri-adr-0001: {uri-project}/blob/master/docs/architecture/content/adr/0001-minimum-node-version.adoc
// External URIs:
:uri-git-dl: {uri-git}/downloads
......@@ -189,10 +191,11 @@ This is also the recommended version of Node for development.
.Why Node 8?
This project leverages the latest and greatest features of ECMAScript, namely ECMAScript 2017 (ES2017).
The main feature of ES2017 this project depends on is Async Functions (with the new `async` & `await` keywords).
It drastically simplifies our asynchronous code.
In order to use this feature, we need least Node v7.10.1.
For stability reasons, we decided to go for Node 8 since our dependencies are compatible and it will have longer support.
The main feature of ES2017 this project depends on is the {uri-async-func}[Async Function] (which introduced the `async` and `await` keywords).
This feature drastically simplifies our asynchronous code.
Node 8 is the first long-term support (LTS) release that provides this feature, which is why it's defined as the prerequisite.
You can read more about the decision to set Node 8 as the minimum required version in {uri-adr-0001}[ADR 0001: Minimum Node Version].
If you don't yet have Node installed, or the version of Node you have isn't Node 8, we strongly recommend using {uri-nvm}[nvm] (Node Version Manager) to manage your Node installations.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment