Skip to content

Commit b885725

Browse files
authored
elastisearch.js is no longer maintained
We no longer maintain the `elasticsearch.js` client. We strongly advise users to migrate to the new [Elasticsearch JavaScript client][0]. ### Changes * Updates several links for new docs URLs added with elastic/docs#2318. * Adds a page header to direct doc readers to the new client. * Updates the `docs/README` to indicate the documentation is no longer maintained. * Removes the contribution guidelines and the `README`'s questions section. [0]: https://www.elastic.co/guide/en/elasticsearch/client/elasticsearch-js/current/index.html
2 parents 7dc350f + f9d81c6 commit b885725

File tree

6 files changed

+17
-113
lines changed

6 files changed

+17
-113
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
The changelog has moved to https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/16.x/changelog.html
1+
The changelog has moved to https://www.elastic.co/guide/en/elasticsearch/elasticsearch-js/16.x/changelog.html

CONTRIBUTING.md

Lines changed: 0 additions & 89 deletions
This file was deleted.

README.md

Lines changed: 5 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
---
44

55
#### We have released the [new JavaScript client](https://www.elastic.co/blog/new-elasticsearch-javascript-client-released)!
6-
*In the next months this client will be deprecated, so you should start migrating your codebase as soon as possible.<br/>
7-
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).*
6+
* This client is no longer maintained. We strongly advise you to migrate to the new client.<br/>
7+
We have built a [migration guide](https://www.elastic.co/guide/en/elasticsearch/client/elasticsearch-js/current/breaking-changes.html) that will help you move to the new client quickly. If you have questions or need help, please [open an issue](https://github.com/elastic/elasticsearch-js/issues/new/choose).*
88

99
---
1010

@@ -16,7 +16,7 @@ The official low-level Elasticsearch client for Node.js and the browser.
1616
## Features
1717

1818
- One-to-one mapping with REST API and the other official clients
19-
- Generalized, pluggable architecture. See [Extending Core Components](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/16.x/extending_core_components.html)
19+
- Generalized, pluggable architecture.
2020
- Configurable, automatic discovery of cluster nodes
2121
- Persistent, Keep-Alive connections
2222
- Load balancing (with pluggable selection strategy) across all available nodes.
@@ -29,27 +29,13 @@ npm install elasticsearch
2929

3030
[![NPM Stats](https://nodei.co/npm/elasticsearch.png?downloads=true)](https://npmjs.org/package/elasticsearch)
3131

32-
## Use in the Browser
33-
34-
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.
35-
3632
## Docs
37-
- [Quick Start](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/16.x/quick-start.html)
38-
- [Browser Builds](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/16.x/browser-builds.html)
39-
- [API](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/16.x/api-reference.html)
40-
- [Configuration](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/16.x/configuration.html)
41-
- [Development/Contributing](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/16.x/contributing.html)
42-
- [Extending Core Components](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/16.x/extending_core_components.html)
43-
- [Logging](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/16.x/logging.html)
44-
45-
46-
## Questions?
47-
You can probably find help in [#kibana](https://kiwiirc.com/client/irc.freenode.net/?#kibana) on freenode.
4833

34+
Documentation can be found on [elastic.co](https://www.elastic.co/guide/en/elasticsearch/client/elasticsearch-js/16.x/index.html).
4935

5036
## Supported Elasticsearch Versions
5137

52-
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 Elasticsearch 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)
38+
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 Elasticsearch you are using, and therefore the API it should provide, set the `apiVersion` config param.
5339

5440
## Examples
5541

@@ -108,8 +94,6 @@ for (const tweet of response.hits.hits) {
10894
}
10995
```
11096

111-
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)
112-
11397
## License
11498

11599
This software is licensed under the Apache 2 license, quoted below.

docs/README.asciidoc

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,7 @@
1-
= These files are used to build http://www.elasticsearch.org/guide/en/elasticsearch/client/javascript-api/current/index.html
1+
= These files are used to build http://www.elasticsearch.org/guide/en/elasticsearch/client/elasticsearch-js/16.x/index.html
2+
3+
This documentation is no longer maintained. Pull requests and issues will not be
4+
addressed.
5+
6+
To contribute to the current JavaScript client docs, refer to the [Elasticsearch
7+
JavaScript client repository](https://github.com/elastic/elasticsearch-js).

docs/page_header.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
<p>
2+
<strong>IMPORTANT:</strong> elasticsearch.js has been replaced by the new <a href="https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/index.html">Elasticsearch JavaScript client</a>. We strongly advise you to migrate to the new client. To learn more, see the <a href="https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/breaking-changes.html">migration guide</a>.
3+
</p>

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"name": "elasticsearch",
77
"description": "The official low-level Elasticsearch client for Node.js and the browser.",
88
"main": "src/elasticsearch.js",
9-
"homepage": "https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/16.x/index.html",
9+
"homepage": "https://www.elastic.co/guide/en/elasticsearch/client/elasticsearch-js/16.x/index.html",
1010
"version": "16.7.2",
1111
"keywords": [
1212
"elasticsearch",

0 commit comments

Comments
 (0)