[DOCS] Updates xpack and api READMEs

picandocodigo · picandocodigo · commit 3d9cfed416f0 · 2021-10-07T10:58:50.000+01:00
diff --git a/elasticsearch-api/README.md b/elasticsearch-api/README.md
@@ -1,56 +1,36 @@
 # Elasticsearch::API
 
-**This library is part of the [`elasticsearch-ruby`](https://github.com/elasticsearch/elasticsearch-ruby/) package;
-please refer to it, unless you want to use this library standalone.**
+**This library is part of the [`elasticsearch-ruby`](https://github.com/elasticsearch/elasticsearch-ruby/) package; please refer to it, unless you want to use this library standalone.**
 
 ----
 
-The `elasticsearch-api` library provides a Ruby implementation of
-the [Elasticsearch](http://elasticsearch.com) REST API.
+The `elasticsearch-api` library provides a Ruby implementation of the [Elasticsearch](http://elasticsearch.com) REST API.
 
-It does not provide an Elasticsearch client; see the
-[`elasticsearch-transport`](https://github.com/elasticsearch/elasticsearch-ruby/tree/master/elasticsearch-transport) library.
+It does not provide an Elasticsearch client; see the [`elasticsearch-transport`](https://github.com/elasticsearch/elasticsearch-ruby/tree/master/elasticsearch-transport) library.
 
-The library is compatible with Ruby 1.9 and higher.
-
-It is compatible with Elasticsearch's API versions from 0.90 till current, just use a release matching major version of Elasticsearch.
-
-| Ruby          |   | Elasticsearch |
-|:-------------:|:-:| :-----------: |
-| 0.90          | → | 0.90          |
-| 1.x           | → | 1.x           |
-| 2.x           | → | 2.x           |
-| 5.x           | → | 5.x           |
-| 6.x           | → | 6.x           |
-| 7.x           | → | 7.x           |
-| master        | → | master        |
+Language clients are forward compatible; meaning that clients support communicating with greater or equal minor versions of Elasticsearch. Elasticsearch language clients are only backwards compatible with default distributions and without guarantees made.
 
 ## Installation
 
 Install the package from [Rubygems](https://rubygems.org):
 
-    gem install elasticsearch-api
-
-To use an unreleased version, either add it to your `Gemfile` for [Bundler](http://gembundler.com):
-
-    gem 'elasticsearch-api', git: 'git://github.com/elasticsearch/elasticsearch-ruby.git'
+```
+gem install elasticsearch-api
+```
 
-or install it from a source code checkout:
+Or add it to your Gemfile:
 
-    git clone https://github.com/elasticsearch/elasticsearch-ruby.git
-    cd elasticsearch-ruby/elasticsearch-api
-    bundle install
-    rake install
+```
+gem 'elasticsearch-api'
+```
 
 ## Usage
 
-The library is designed as a group of standalone Ruby modules, which can be mixed into a class
-providing connection to Elasticsearch -- an Elasticsearch client.
+The library is designed as a group of standalone Ruby modules, which can be mixed into a class providing connection to Elasticsearch -- an Elasticsearch client. It's possible to mix it into any client, and the methods will be available in the top namespace.
 
 ### Usage with the `elasticsearch` gem
 
-**When you use the client from the [`elasticsearch-ruby`](https://github.com/elasticsearch/elasticsearch-ruby/) package,
-the library modules have been already included**, so you just call the API methods:
+**When you use the client from the [`elasticsearch-ruby`](https://github.com/elasticsearch/elasticsearch-ruby/) package, the library modules have been already included**, so you just call the API methods:
 
 ```ruby
 require 'elasticsearch'
@@ -64,8 +44,7 @@ client.search(index: 'myindex', body: { query: { match: { title: 'test' } } })
 # => {"took"=>2, ..., "hits"=>{"total":5, ...}}
 ```
 
-Full documentation and examples are included as RDoc annotations in the source code
-and available online at <http://rubydoc.info/gems/elasticsearch-api>.
+Full documentation is included as RDoc annotations in the source code and available online at <http://rubydoc.info/gems/elasticsearch-api>.
 
 ### Usage with a custom client
 
diff --git a/elasticsearch-xpack/README.md b/elasticsearch-xpack/README.md
@@ -1,45 +1,42 @@
 # Elasticsearch::XPack
 
-A Ruby integration for the [X-Pack extension](https://www.elastic.co/guide/en/x-pack/current/xpack-introduction.html) for Elasticsearch.
+----
+⚠ **This library is deprecated** ⚠
 
+The API endpoints currently living in `elasticsearch-xpack` will be moved into `elasticsearch-api` in version 8.0.0 and forward. You should be able to keep using `elasticsearch-xpack` and the `xpack` namespace in `7.x`. We're running the same tests in `elasticsearch-xpack`, but if you encounter any problems, please let us know [in this issue](https://github.com/elastic/elasticsearch-ruby/issues/1274).
 
-## Installation
+However, be aware in `8.0`, the xpack library and namespace won't be available anymore.
 
-Install the package from [Rubygems](https://rubygems.org):
+----
 
-    gem install elasticsearch-xpack
+A Ruby integration for the [X-Pack extension](https://www.elastic.co/guide/en/x-pack/current/xpack-introduction.html) for Elasticsearch.
 
-To use an unreleased version, either add it to your `Gemfile` for [Bundler](http://gembundler.com):
+## Installation
 
-    gem 'elasticsearch-xpack', git: 'https://github.com/elastic/elasticsearch-ruby.git'
+Install the package from [Rubygems](https://rubygems.org):
 
+    gem install elasticsearch-api
 
 ## Usage
 
-If you use the official [Ruby client for Elasticsearch](https://github.com/elastic/elasticsearch-ruby),
-require the library in your code, and all the methods will be automatically available in the `xpack` namespace:
+If you use the official [Ruby client for Elasticsearch](https://github.com/elastic/elasticsearch-ruby), all the methods will be automatically available:
 
 ```ruby
 require 'elasticsearch'
-require 'elasticsearch/xpack'
 
-client = Elasticsearch::Client.new url: 'http://elastic:changeme@localhost:9200'
+client = Elasticsearch::Client.new(url: 'http://elastic:changeme@localhost:9200')
 
 client.xpack.info
 # => {"build"=> ..., "features"=> ...}
 ```
 
-The integration is designed as a standalone `Elasticsearch::XPack::API` module, so it's easy
-to mix it into a different client, and the methods will be available in the top namespace.
+The integration is designed as a standalone `Elasticsearch::XPack::API` module, so it's easy to mix it into a different client, and the methods will be available in the top namespace.
 
-For documentation, look into the RDoc annotations in the source files, which contain links to the
-official [X-Pack for the Elastic Stack](https://www.elastic.co/guide/en/x-pack/current/index.html) documentation.
+For documentation, look into the RDoc annotations in the source files, which contain links to the official [X-Pack for the Elastic Stack](https://www.elastic.co/guide/en/x-pack/current/index.html) documentation.
 
 For examples, look into the [`examples`](examples) folder in this repository.
 
-You can use the provided `test:elasticsearch` Rake task to launch
-a [Docker-based](https://www.elastic.co/guide/en/elasticsearch/reference/current/docker.html)
-Elasticsearch node with the full X-Pack license preinstalled.
+You can use the provided `test:elasticsearch` Rake task to launch a [Docker-based](https://www.elastic.co/guide/en/elasticsearch/reference/current/docker.html) Elasticsearch node with the full X-Pack license preinstalled.
 
 ## License
 
