From c2437a102667e5cb31c0d214510fedef5a646747 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:39:29 +0100 Subject: [PATCH 1/4] [DOCS] Adds compatibility matrix to the docs and readme. --- README.md | 18 ++++++++++++++---- docs/install.asciidoc | 25 +++++++++++++++++++------ 2 files changed, 33 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index cbfc506f5bc..51ed2887c47 100644 --- a/README.md +++ b/README.md @@ -17,10 +17,20 @@ The .NET client for Elasticsearch provides strongly typed requests and responses ## 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-Java Branch | Supported | +| --------------------- | ------------------------- | --------- | +| main | main | | +| 8.x | 8.x | 8.x | +| 7.x | 7.x | 7.17 | ## Installation diff --git a/docs/install.asciidoc b/docs/install.asciidoc index bed347276f6..786050f5f07 100644 --- a/docs/install.asciidoc +++ b/docs/install.asciidoc @@ -58,12 +58,25 @@ To learn how to connect the {es} client, refer to the <> === Compatibility The {es} client is compatible with currently maintained .NET runtime versions. -Compatibility with End of Life (EOL) .NET runtimes is not guaranteed or supported. - -Language clients are forward compatible; meaning that clients support -communicating with greater or equal minor versions of {es}. {es} language -clients are only backward compatible with default distributions and without -guarantees made. +Compatibility with End of Life (EOL) .NET runtimes is not guaranteed or +supported. + +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-NET Branch | Supported + +| main | main | +| 8.x | 8.x | 8.x +| 7.x | 7.x | 7.17 +|=== Refer to the https://www.elastic.co/support/eol[end-of-life policy] for more information. From 5fa3e8d7e4022d7e564c58bb8bc2b1747640213a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Mon, 4 Mar 2024 14:24:24 +0100 Subject: [PATCH 2/4] Apply suggestions from code review --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 51ed2887c47..72a38fa533d 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ 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-Java Branch | Supported | +| Elasticsearch Version | Elasticsearch-NET Branch | Supported | | --------------------- | ------------------------- | --------- | | main | main | | | 8.x | 8.x | 8.x | From ab2add6570cc0090472ee2b65e2e5592981a8fcf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Mon, 4 Mar 2024 14:25:14 +0100 Subject: [PATCH 3/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 72a38fa533d..495f2a5cb89 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ 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-NET Branch | Supported | +| Elasticsearch Version | Elasticsearch-NET Branch | Supported | | --------------------- | ------------------------- | --------- | | main | main | | | 8.x | 8.x | 8.x | From b461294908f22feb6117e1e2d9f4f16dbbbdc10a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Mon, 4 Mar 2024 14:25:52 +0100 Subject: [PATCH 4/4] Apply suggestions from code review --- docs/install.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/install.asciidoc b/docs/install.asciidoc index 786050f5f07..09a383cda5a 100644 --- a/docs/install.asciidoc +++ b/docs/install.asciidoc @@ -71,7 +71,7 @@ language clients are only backwards compatible with default distributions and without guarantees made. |=== -| Elasticsearch Version | Elasticsearch-NET Branch | Supported +| Elasticsearch Version | Elasticsearch-NET Branch | Supported | main | main | | 8.x | 8.x | 8.x