From 9bb06c1058e44d7aaa46de67296f2ee1f18d1044 Mon Sep 17 00:00:00 2001 From: delvedor Date: Fri, 24 May 2019 18:27:50 +0200 Subject: [PATCH 1/3] Updated README.md - Added a note about the new JS client - Updated documentation links --- README.md | 30 +++++++++++++++++++----------- 1 file changed, 19 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index d008bfa2..b617a244 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,13 @@ # elasticsearch.js 16.0.0 +--- + +#### We have released the [new JavaScript client](https://www.elastic.co/blog/new-elasticsearch-javascript-client-released)! +*In the next months this client will be deprecated, so you should start migrating your codebase as soon as possible.
+We have built a [migration guide](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/breaking-changes.html) that will help you move to the new client quickly, and if you have questions or need help, please [open an issue](https://github.com/elastic/elasticsearch-js/issues/new/choose).* + +--- + The official low-level Elasticsearch client for Node.js and the browser. [![Coverage Status](http://img.shields.io/coveralls/elastic/elasticsearch-js/master.svg?style=flat-square)](https://coveralls.io/r/elastic/elasticsearch-js?branch=master) @@ -8,7 +16,7 @@ The official low-level Elasticsearch client for Node.js and the browser. ## Features - One-to-one mapping with REST API and the other official clients - - Generalized, pluggable architecture. See [Extending Core Components](http://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/extending_core_components.html) + - Generalized, pluggable architecture. See [Extending Core Components](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/16.x/extending_core_components.html) - Configurable, automatic discovery of cluster nodes - Persistent, Keep-Alive connections - Load balancing (with pluggable selection strategy) across all available nodes. @@ -23,16 +31,16 @@ npm install elasticsearch ## Use in the Browser -Check out the [Browser Builds](http://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/browser-builds.html) doc page for help downloading and setting up the client for use in the browser. +Check out the [Browser Builds](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/16.x/browser-builds.html) doc page for help downloading and setting up the client for use in the browser. ## Docs - - [Quick Start](http://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/quick-start.html) - - [Browser Builds](http://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/browser-builds.html) - - [API](http://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/api-reference.html) - - [Configuration](http://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/configuration.html) - - [Development/Contributing](https://github.com/elastic/elasticsearch-js/blob/master/CONTRIBUTING.md) - - [Extending Core Components](http://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/extending_core_components.html) - - [Logging](http://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/logging.html) + - [Quick Start](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/16.x/quick-start.html) + - [Browser Builds](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/16.x/browser-builds.html) + - [API](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/16.x/api-reference.html) + - [Configuration](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/16.x/configuration.html) + - [Development/Contributing](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/16.x/contributing.html) + - [Extending Core Components](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/16.x/extending_core_components.html) + - [Logging](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/16.x/logging.html) ## Questions? @@ -41,7 +49,7 @@ You can probably find help in [#kibana](https://kiwiirc.com/client/irc.freenode. ## Supported Elasticsearch Versions -Elasticsearch.js provides support for, and is regularly tested against, Elasticsearch releases 0.90.12 and greater. We also test against the latest changes in several branches in the Elasticsearch repository. To tell the client which version of Elastisearch you are using, and therefore the API it should provide, set the `apiVersion` config param. [More info](http://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/configuration.html#config-options) +Elasticsearch.js provides support for, and is regularly tested against, Elasticsearch releases 0.90.12 and greater. We also test against the latest changes in several branches in the Elasticsearch repository. To tell the client which version of Elastisearch you are using, and therefore the API it should provide, set the `apiVersion` config param. [More info](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/16.x/configuration.html#config-options) ## Examples @@ -99,7 +107,7 @@ for (const tweet of response.hits.hits) { } ``` -More examples and detailed information about each method are available [here](http://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/index.html) +More examples and detailed information about each method are available [here](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/16.x/index.html) ## License From c070cf32b15b2f0f3c54187836ab5b6cf1ddc65b Mon Sep 17 00:00:00 2001 From: delvedor Date: Fri, 24 May 2019 18:30:47 +0200 Subject: [PATCH 2/3] Updated changelog url --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6b612d8a..d169c623 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1 +1 @@ -The changelog has moved to https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/changelog.html +The changelog has moved to https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/16.x/changelog.html From 35bfca75b4d271b8cb3e5307c02751ff5c13c872 Mon Sep 17 00:00:00 2001 From: delvedor Date: Fri, 24 May 2019 18:31:01 +0200 Subject: [PATCH 3/3] Updated homepage and repository fields --- package.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/package.json b/package.json index 0204ccaa..6d6b33c8 100644 --- a/package.json +++ b/package.json @@ -6,7 +6,7 @@ "name": "elasticsearch", "description": "The official low-level Elasticsearch client for Node.js and the browser.", "main": "src/elasticsearch.js", - "homepage": "http://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/index.html", + "homepage": "https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/16.x/index.html", "version": "16.0.0", "keywords": [ "elasticsearch", @@ -111,9 +111,9 @@ }, "repository": { "type": "git", - "url": "http://github.com/elastic/elasticsearch-js.git" + "url": "https://github.com/elastic/elasticsearch-js-legacy.git" }, "engines": { "node": ">=0.8" } -} \ No newline at end of file +}