[DOCS] Added compatibility section in doc + updated release notes #1163
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
szabosteve
reviewed
Sep 13, 2021
docs/compatibility.asciidoc
Outdated
Comment on lines
1
to
7
| [[compatibility]] | ||
| == 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. |
There was a problem hiding this comment.
In the rest of the Client books, we added the compatibility information to the Installation section as a level-three sub-section:
[discrete]
[[compatibility]]
=== Compatibility
If there is no particular reason to add this info as a separate section, I would suggest moving this content under the Installation section.
docs/index.asciidoc
Outdated
| @@ -5,6 +5,8 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[] | |||
|
|
|||
| include::overview.asciidoc[] | |||
|
|
|||
| include::compatibility.asciidoc[] | |||
There was a problem hiding this comment.
If you move the compatibility info under Installation, then this item can be deleted.
Suggested change
| include::compatibility.asciidoc[] |
ezimuel
commented
Sep 13, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR provides the following changes in the documentation:
Moreover it updates the README with the new compatibility section content.