Skip to content

[Backport 8.12] [DOCS] Adds compatibility matrix to docs and readme #2459

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 23, 2024
Merged

[Backport 8.12] [DOCS] Adds compatibility matrix to docs and readme #2459

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 19 additions & 4 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,12 +72,27 @@ Usage
Compatibility
-------------

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.
Language clients are forward compatible; meaning that the clients support
communicating with greater or equal minor versions of Elasticsearch without
breaking. It does not mean that the clients automatically support new features
of newer Elasticsearch versions; it is only possible after a release of a new
client version. For example, a 8.12 client version won't automatically support
the new features of the 8.13 version of Elasticsearch, the 8.13 client version
is required for that. Elasticsearch language clients are only backwards
compatible with default distributions and without guarantees made.

+-----------------------+-------------------------+-----------+
| Elasticsearch version | elasticsearch-py branch | Supported |
+=======================+=========================+===========+
| main | main | |
+-----------------------+-------------------------+-----------+
| 8.x | 8.x | 8.x |
+-----------------------+-------------------------+-----------+
| 7.x | 7.x | 7.17 |
+-----------------------+-------------------------+-----------+

If you have a need to have multiple versions installed at the same time older
versions are also released as ``elasticsearch2`` and ``elasticsearch5``.
versions are also released as ``elasticsearch7`` and ``elasticsearch8``.


Documentation
Expand Down
4 changes: 2 additions & 2 deletions docs/guide/installation.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
[[installation]]
== Installation

**[Download the latest version of Elasticsearch](https://www.elastic.co/downloads/elasticsearch)**
**https://www.elastic.co/downloads/elasticsearch[Download the latest version of Elasticsearch]**
or
**[sign-up](https://cloud.elastic.co/registration?elektra=en-ess-sign-up-page)**
**https://cloud.elastic.co/registration?elektra=en-ess-sign-up-page[sign-up]**
**for a free trial of Elastic Cloud**.

The Python client for {es} can be installed with pip:
Expand Down
21 changes: 17 additions & 4 deletions docs/guide/overview.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,25 @@ on https://elasticsearch-py.readthedocs.io[Read the Docs].
[discrete]
=== Compatibility

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.
Language clients are forward compatible; meaning that the clients support
communicating with greater or equal minor versions of {es} without breaking. It
does not mean that the clients automatically support new features of newer
{es} versions; it is only possible after a release of a new client version. For
example, a 8.12 client version won't automatically support the new features of
the 8.13 version of {es}, the 8.13 client version is required for that. {es}
language clients are only backwards compatible with default distributions and
without guarantees made.

|===
| Elasticsearch version | elasticsearch-py branch | Supported

| main | main |
| 8.x | 8.x | 8.x
| 7.x | 7.x | 7.17
|===

If you have a need to have multiple versions installed at the same time older
versions are also released as `elasticsearch2` and `elasticsearch5`.
versions are also released as `elasticsearch7` and `elasticsearch8`.


[discrete]
Expand Down
21 changes: 18 additions & 3 deletions docs/sphinx/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,24 @@ Read more about `how to use asyncio with this project <async.html>`_.
Compatibility
-------------

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.
Language clients are forward compatible; meaning that the clients support
communicating with greater or equal minor versions of Elasticsearch without
breaking. It does not mean that the clients automatically support new features
of newer Elasticsearch versions; it is only possible after a release of a new
client version. For example, a 8.12 client version won't automatically support
the new features of the 8.13 version of Elasticsearch, the 8.13 client version
is required for that. Elasticsearch language clients are only backwards
compatible with default distributions and without guarantees made.

+-----------------------+-------------------------+-----------+
| Elasticsearch version | elasticsearch-py branch | Supported |
+=======================+=========================+===========+
| main | main | |
+-----------------------+-------------------------+-----------+
| 8.x | 8.x | 8.x |
+-----------------------+-------------------------+-----------+
| 7.x | 7.x | 7.17 |
+-----------------------+-------------------------+-----------+

If you need multiple versions installed at the same time, versions are
also released, such as ``elasticsearch7`` and ``elasticsearch8``.
Expand Down