From 60a6d0d512e4154dc2f1b26256cc6fd251241198 Mon Sep 17 00:00:00 2001 From: Julian Simioni Date: Tue, 30 Oct 2018 13:37:26 -0400 Subject: [PATCH 1/4] Update Node.js requirements documentation section Expand description of supported Node.js versions. Drop support for Node.js 6 Add recommendation for Node.js 10 Connects https://github.com/pelias/pelias/issues/752 --- requirements.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/requirements.md b/requirements.md index 7052be4..6d7f9c9 100644 --- a/requirements.md +++ b/requirements.md @@ -6,14 +6,12 @@ install all our dependencies yourself. ## Node.js -Version 6 or newer +Most Pelias code is written in Node.js. -Most Pelias code is written in Node.js. Node.js 8 is recommended. -Node.js 10 is not as well tested with Pelias yet, but should offer notable performance increases and -may become the recommendation soon. +Version 8 or newer is required, version 10 is recommended for improved performance. -We will probably drop support for Node.js 6 in the near future, so that we can use the many features -supported only in version 8 and above. +Pelias generally only adds support for even numbered [LTS](https://github.com/nodejs/Release#release-schedule) Node.js versions. +However we gladly accept patches and bug reports regarding issues with any Node.js version that has not reached end-of-life. ## Elasticsearch From e253b555e28586a9bd57b5d5fc70b1691a43693a Mon Sep 17 00:00:00 2001 From: Julian Simioni Date: Tue, 30 Oct 2018 13:40:11 -0400 Subject: [PATCH 2/4] Update Elasticsearch requirements --- requirements.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/requirements.md b/requirements.md index 6d7f9c9..f55378b 100644 --- a/requirements.md +++ b/requirements.md @@ -15,11 +15,13 @@ However we gladly accept patches and bug reports regarding issues with any Node. ## Elasticsearch -Version 2.3 or 2.4 +Version 2.4 or 5.6 The core data storage for Pelias is Elasticsearch. We recommend the latest in the 2.4 release line. -We do not _yet_ support Elasticsearch 5 or 6, but work is [ongoing](https://github.com/pelias/pelias/issues/461) +Support for [Elasticsearch 5](https://github.com/pelias/pelias/issues/461) is new and should not yet be considered production-ready. + +[Elasticsearch 6](https://github.com/pelias/pelias/issues/719) support will follow once Elasticsearch 5 has been the recommended version for some time. ## SQLite From 5121f5ab9ccb50afca4ec1f8bf1044b6385a6ed4 Mon Sep 17 00:00:00 2001 From: Julian Simioni Date: Tue, 30 Oct 2018 13:42:18 -0400 Subject: [PATCH 3/4] Fix typo --- requirements.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.md b/requirements.md index f55378b..e2f81e0 100644 --- a/requirements.md +++ b/requirements.md @@ -25,7 +25,7 @@ Support for [Elasticsearch 5](https://github.com/pelias/pelias/issues/461) is ne ## SQLite -Version 3.11 or newerr +Version 3.11 or newer Some components of Pelias need a relational database, and Elasticsarch does not provide good relational support. We use SQLite in these cases since it's simple to manage and quite performant. From 6a766d27ef9d9d10c1dd590ae61cb90fd0cb91f0 Mon Sep 17 00:00:00 2001 From: Julian Simioni Date: Tue, 30 Oct 2018 13:42:35 -0400 Subject: [PATCH 4/4] Fix typo --- requirements.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.md b/requirements.md index e2f81e0..62b0f5f 100644 --- a/requirements.md +++ b/requirements.md @@ -27,7 +27,7 @@ Support for [Elasticsearch 5](https://github.com/pelias/pelias/issues/461) is ne Version 3.11 or newer -Some components of Pelias need a relational database, and Elasticsarch does not provide good +Some components of Pelias need a relational database, and Elasticsearch does not provide good relational support. We use SQLite in these cases since it's simple to manage and quite performant. ## Libpostal