Skip to content

[DOCS] Adds compatibility matrix to the docs and readme #8045

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 4, 2024
Merged

[DOCS] Adds compatibility matrix to the docs and readme #8045

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c2437a1
[DOCS] Adds compatibility matrix to the docs and readme.
szabosteve Feb 22, 2024
5fa3e8d
Apply suggestions from code review
szabosteve Mar 4, 2024
ab2add6
Update README.md
szabosteve Mar 4, 2024
b461294
Apply suggestions from code review
szabosteve Mar 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 14 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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-NET Branch | Supported |
| --------------------- | ------------------------- | --------- |
| main | main | |
| 8.x | 8.x | 8.x |
| 7.x | 7.x | 7.17 |

## Installation

Expand Down
25 changes: 19 additions & 6 deletions docs/install.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,12 +58,25 @@ To learn how to connect the {es} client, refer to the <<connecting,Connecting>>
=== 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.
Expand Down