Skip to content

Commit 44c5c69

Browse files
szabostevepquentin
andauthored
[DOCS] Adds compatibility matrix to docs and readme (elastic#2458)
Co-authored-by: Quentin Pradet <[email protected]>
1 parent fcd0323 commit 44c5c69

File tree

4 files changed

+56
-13
lines changed

4 files changed

+56
-13
lines changed

README.rst

+19-4
Original file line numberDiff line numberDiff line change
@@ -75,12 +75,27 @@ Usage
7575
Compatibility
7676
-------------
7777

78-
Language clients are forward compatible; meaning that clients support communicating
79-
with greater or equal minor versions of Elasticsearch. Elasticsearch language clients
80-
are only backwards compatible with default distributions and without guarantees made.
78+
Language clients are forward compatible; meaning that the clients support
79+
communicating with greater or equal minor versions of Elasticsearch without
80+
breaking. It does not mean that the clients automatically support new features
81+
of newer Elasticsearch versions; it is only possible after a release of a new
82+
client version. For example, a 8.12 client version won't automatically support
83+
the new features of the 8.13 version of Elasticsearch, the 8.13 client version
84+
is required for that. Elasticsearch language clients are only backwards
85+
compatible with default distributions and without guarantees made.
86+
87+
+-----------------------+-------------------------+-----------+
88+
| Elasticsearch version | elasticsearch-py branch | Supported |
89+
+=======================+=========================+===========+
90+
| main | main | |
91+
+-----------------------+-------------------------+-----------+
92+
| 8.x | 8.x | 8.x |
93+
+-----------------------+-------------------------+-----------+
94+
| 7.x | 7.x | 7.17 |
95+
+-----------------------+-------------------------+-----------+
8196

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

85100

86101
Documentation

docs/guide/installation.asciidoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
[[installation]]
22
== Installation
33

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

99
The Python client for {es} can be installed with pip:

docs/guide/overview.asciidoc

+17-4
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,25 @@ on https://elasticsearch-py.readthedocs.io[Read the Docs].
1010
[discrete]
1111
=== Compatibility
1212

13-
Language clients are forward compatible; meaning that clients support communicating
14-
with greater or equal minor versions of Elasticsearch. Elasticsearch language clients
15-
are only backwards compatible with default distributions and without guarantees made.
13+
Language clients are forward compatible; meaning that the clients support
14+
communicating with greater or equal minor versions of {es} without breaking. It
15+
does not mean that the clients automatically support new features of newer
16+
{es} versions; it is only possible after a release of a new client version. For
17+
example, a 8.12 client version won't automatically support the new features of
18+
the 8.13 version of {es}, the 8.13 client version is required for that. {es}
19+
language clients are only backwards compatible with default distributions and
20+
without guarantees made.
21+
22+
|===
23+
| Elasticsearch version | elasticsearch-py branch | Supported
24+
25+
| main | main |
26+
| 8.x | 8.x | 8.x
27+
| 7.x | 7.x | 7.17
28+
|===
1629

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

2033

2134
[discrete]

docs/sphinx/index.rst

+18-3
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,24 @@ Read more about `how to use asyncio with this project <async.html>`_.
3434
Compatibility
3535
-------------
3636

37-
Language clients are forward compatible; meaning that clients support communicating
38-
with greater or equal minor versions of Elasticsearch. Elasticsearch language clients
39-
are only backwards compatible with default distributions and without guarantees made.
37+
Language clients are forward compatible; meaning that the clients support
38+
communicating with greater or equal minor versions of Elasticsearch without
39+
breaking. It does not mean that the clients automatically support new features
40+
of newer Elasticsearch versions; it is only possible after a release of a new
41+
client version. For example, a 8.12 client version won't automatically support
42+
the new features of the 8.13 version of Elasticsearch, the 8.13 client version
43+
is required for that. Elasticsearch language clients are only backwards
44+
compatible with default distributions and without guarantees made.
45+
46+
+-----------------------+-------------------------+-----------+
47+
| Elasticsearch version | elasticsearch-py branch | Supported |
48+
+=======================+=========================+===========+
49+
| main | main | |
50+
+-----------------------+-------------------------+-----------+
51+
| 8.x | 8.x | 8.x |
52+
+-----------------------+-------------------------+-----------+
53+
| 7.x | 7.x | 7.17 |
54+
+-----------------------+-------------------------+-----------+
4055

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

0 commit comments

Comments
 (0)