Skip to content

Commit

Permalink
[DOCS] Adds compatibility matrix to the Install section (#2316)
Browse files Browse the repository at this point in the history
* [DOCS] Adds compatibility matrix to the Install section and README

Co-authored-by: Fernando Briano <fernando@picandocodigo.net>
  • Loading branch information
szabosteve and picandocodigo committed Feb 21, 2024
1 parent 2172a8b commit 2823126
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 4 deletions.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
24 changes: 21 additions & 3 deletions docs/installation.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
|===

0 comments on commit 2823126

Please sign in to comment.