From 755f0db139732058efd99fc4313d543558b835d0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Thu, 22 Feb 2024 14:57:07 +0100 Subject: [PATCH 1/6] [DOCS] Fixes markup on Installation page. --- docs/guide/installation.asciidoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/guide/installation.asciidoc b/docs/guide/installation.asciidoc index d745b98aa..c30ce49d6 100644 --- a/docs/guide/installation.asciidoc +++ b/docs/guide/installation.asciidoc @@ -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: From 7aa843f3cdc8236a4d5cccb65dc70df5cd00aa87 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Thu, 22 Feb 2024 15:02:55 +0100 Subject: [PATCH 2/6] [DOCS] Adds compatibility matrix to docs and readme. --- README.rst | 19 ++++++++++++++++--- docs/guide/overview.asciidoc | 19 ++++++++++++++++--- 2 files changed, 32 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index 92e7fc29d..cb9b2f5b4 100644 --- a/README.rst +++ b/README.rst @@ -75,9 +75,22 @@ 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``. diff --git a/docs/guide/overview.asciidoc b/docs/guide/overview.asciidoc index 56a1a75f9..e1f1a0f3e 100644 --- a/docs/guide/overview.asciidoc +++ b/docs/guide/overview.asciidoc @@ -10,9 +10,22 @@ 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`. From 54b2bda0c8b1d99e7be973a8de5d0b561e7dd6d3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Fri, 23 Feb 2024 10:27:53 +0100 Subject: [PATCH 3/6] Apply suggestions from code review Co-authored-by: Quentin Pradet --- README.rst | 2 +- docs/guide/overview.asciidoc | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index cb9b2f5b4..44206fe90 100644 --- a/README.rst +++ b/README.rst @@ -93,7 +93,7 @@ compatible with default distributions and without guarantees made. +-----------------------+-------------------------+-----------+ 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 diff --git a/docs/guide/overview.asciidoc b/docs/guide/overview.asciidoc index e1f1a0f3e..4e8222597 100644 --- a/docs/guide/overview.asciidoc +++ b/docs/guide/overview.asciidoc @@ -28,7 +28,7 @@ without guarantees made. |=== 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] From 625c6fb3c0f676241d27f4f84b766fa2d152b127 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Fri, 23 Feb 2024 10:29:50 +0100 Subject: [PATCH 4/6] [DOCS] Updates index.rst with compatibility info. --- docs/sphinx/index.rst | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/docs/sphinx/index.rst b/docs/sphinx/index.rst index cef9c53ae..952c40a0a 100644 --- a/docs/sphinx/index.rst +++ b/docs/sphinx/index.rst @@ -34,9 +34,22 @@ Read more about `how to use asyncio with this project `_. 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``. From 1e85cb77f25557e8f0b28bc0cb888f695f99cfd0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Fri, 23 Feb 2024 10:44:16 +0100 Subject: [PATCH 5/6] Apply suggestions from code review Co-authored-by: Quentin Pradet --- README.rst | 2 +- docs/guide/overview.asciidoc | 2 +- docs/sphinx/index.rst | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index 44206fe90..2c0a91ab7 100644 --- a/README.rst +++ b/README.rst @@ -85,7 +85,7 @@ is required for that. Elasticsearch language clients are only backwards compatible with default distributions and without guarantees made. +-----------------------+-------------------------+-----------+ -| Elasticsearch Version | Elasticsearch-py Branch | Supported | +| Elasticsearch version | elasticsearch-py branch | Supported | +=======================+=========================+===========+ | main | main | | | 8.x | 8.x | 8.x | diff --git a/docs/guide/overview.asciidoc b/docs/guide/overview.asciidoc index 4e8222597..916dad833 100644 --- a/docs/guide/overview.asciidoc +++ b/docs/guide/overview.asciidoc @@ -20,7 +20,7 @@ language clients are only backwards compatible with default distributions and without guarantees made. |=== -| Elasticsearch Version | Elasticsearch-py Branch | Supported +| Elasticsearch version | elasticsearch-py branch | Supported | main | main | | 8.x | 8.x | 8.x diff --git a/docs/sphinx/index.rst b/docs/sphinx/index.rst index 952c40a0a..07e6f4ff2 100644 --- a/docs/sphinx/index.rst +++ b/docs/sphinx/index.rst @@ -44,7 +44,7 @@ is required for that. Elasticsearch language clients are only backwards compatible with default distributions and without guarantees made. +-----------------------+-------------------------+-----------+ -| Elasticsearch Version | Elasticsearch-py Branch | Supported | +| Elasticsearch version | elasticsearch-py branch | Supported | +=======================+=========================+===========+ | main | main | | | 8.x | 8.x | 8.x | From bae3fc5647f8d025206604e0e53281858a8ac87e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Fri, 23 Feb 2024 10:47:15 +0100 Subject: [PATCH 6/6] [DOCS] Fixes rst table. --- README.rst | 4 +++- docs/sphinx/index.rst | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 44206fe90..a10f7376b 100644 --- a/README.rst +++ b/README.rst @@ -85,10 +85,12 @@ is required for that. Elasticsearch language clients are only backwards compatible with default distributions and without guarantees made. +-----------------------+-------------------------+-----------+ -| Elasticsearch Version | Elasticsearch-py Branch | Supported | +| Elasticsearch version | elasticsearch-py branch | Supported | +=======================+=========================+===========+ | main | main | | ++-----------------------+-------------------------+-----------+ | 8.x | 8.x | 8.x | ++-----------------------+-------------------------+-----------+ | 7.x | 7.x | 7.17 | +-----------------------+-------------------------+-----------+ diff --git a/docs/sphinx/index.rst b/docs/sphinx/index.rst index 952c40a0a..bb2d5a86a 100644 --- a/docs/sphinx/index.rst +++ b/docs/sphinx/index.rst @@ -44,10 +44,12 @@ is required for that. Elasticsearch language clients are only backwards compatible with default distributions and without guarantees made. +-----------------------+-------------------------+-----------+ -| Elasticsearch Version | Elasticsearch-py Branch | Supported | +| Elasticsearch version | elasticsearch-py branch | Supported | +=======================+=========================+===========+ | main | main | | ++-----------------------+-------------------------+-----------+ | 8.x | 8.x | 8.x | ++-----------------------+-------------------------+-----------+ | 7.x | 7.x | 7.17 | +-----------------------+-------------------------+-----------+