Skip to content

Commit 6d7234a

Browse files
[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 <[email protected]>
1 parent d985e13 commit 6d7234a

File tree

2 files changed

+31
-4
lines changed

2 files changed

+31
-4
lines changed

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,16 @@ Please see their respective READMEs for information and documentation.
7272

7373
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/).
7474

75-
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.
75+
Language clients are forward compatible; meaning that clients support communicating with greater or equal minor versions of Elasticsearch without breaking.
76+
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.
77+
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.
78+
Elasticsearch language clients are only backwards compatible with default distributions and without guarantees made.
79+
80+
| Gem Version | | Elasticsearch Version | Supported |
81+
|-------------|---|------------------------|-----------|
82+
| 7.x || 7.x | 7.17 |
83+
| 8.x || 8.x | 8.x |
84+
| main || main | |
7685

7786
## Development
7887

docs/installation.asciidoc

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,24 @@ gem 'elasticsearch', '~> 7.0'
3838
[discrete]
3939
=== {es} and Ruby Version Compatibility
4040

41-
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].
42-
43-
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.
41+
The {es} client is compatible with currently maintained Ruby versions. We follow
42+
Ruby’s own maintenance policy and officially support all currently maintained
43+
versions per
44+
https://www.ruby-lang.org/en/downloads/branches/[Ruby Maintenance Branches].
45+
46+
Language clients are forward compatible; meaning that clients support
47+
communicating with greater or equal minor versions of {es} without breaking. It
48+
does not mean that the client automatically supports new features of newer {es}
49+
versions; it is only possible after a release of a new client version. For
50+
example, a 8.12 client version won't automatically support the new features of
51+
the 8.13 version of {es}, the 8.13 client version is required for that.
52+
{es} language clients are only backwards compatible with default distributions
53+
and without guarantees made.
54+
55+
|===
56+
| Gem Version | | {es} Version | Supported
57+
58+
| 7.x | → | 7.x | 7.17
59+
| 8.x | → | 8.x | 8.x
60+
| main | → | main |
61+
|===

0 commit comments

Comments
 (0)