From 6d7234a1bfacc29492d493626f2e6ecb96d311b4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Wed, 21 Feb 2024 15:25:53 +0100 Subject: [PATCH] [DOCS] Adds compatibility matrix to the Install section (#2316) (#2317) * [DOCS] Adds compatibility matrix to the Install section and README Co-authored-by: Fernando Briano --- README.md | 11 ++++++++++- docs/installation.asciidoc | 24 +++++++++++++++++++++--- 2 files changed, 31 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 11e07a57b1..f83785aab4 100644 --- a/README.md +++ b/README.md @@ -72,7 +72,16 @@ Please see their respective READMEs for information and documentation. We follow Ruby’s own maintenance policy and officially support all currently maintained versions per [Ruby Maintenance Branches](https://www.ruby-lang.org/en/downloads/branches/). -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 clients support communicating with greater or equal minor versions of Elasticsearch without breaking. +It does not mean that the client automatically supports 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. + +| Gem Version | | Elasticsearch Version | Supported | +|-------------|---|------------------------|-----------| +| 7.x | → | 7.x | 7.17 | +| 8.x | → | 8.x | 8.x | +| main | → | main | | ## Development diff --git a/docs/installation.asciidoc b/docs/installation.asciidoc index dd3c2d2ac8..15ce2f60a8 100644 --- a/docs/installation.asciidoc +++ b/docs/installation.asciidoc @@ -38,6 +38,24 @@ gem 'elasticsearch', '~> 7.0' [discrete] === {es} and Ruby Version Compatibility -The {es} client is compatible with currently maintained Ruby versions. We follow Ruby’s own maintenance policy and officially support all currently maintained versions per https://www.ruby-lang.org/en/downloads/branches/[Ruby Maintenance Branches]. - -Language clients are forward compatible; meaning that clients support communicating with greater or equal minor versions of {es}. Elasticsearch language clients are only backwards compatible with default distributions and without guarantees made. +The {es} client is compatible with currently maintained Ruby versions. We follow +Ruby’s own maintenance policy and officially support all currently maintained +versions per +https://www.ruby-lang.org/en/downloads/branches/[Ruby Maintenance Branches]. + +Language clients are forward compatible; meaning that clients support +communicating with greater or equal minor versions of {es} without breaking. It +does not mean that the client automatically supports 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. + +|=== +| Gem Version | | {es} Version | Supported + +| 7.x | → | 7.x | 7.17 +| 8.x | → | 8.x | 8.x +| main | → | main | +|=== \ No newline at end of file