Skip to content

[DOCS] Adds Features subsection to Overview #195

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
szabosteve merged 2 commits into from
Nov 4, 2020
Merged

[DOCS] Adds Features subsection to Overview #195

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
22feb9c
[DOCS] Adds Features subsection to Overview.
szabosteve Nov 3, 2020
2bdf729
[DOCS] Addresses feedback.
szabosteve Nov 4, 2020
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
36 changes: 36 additions & 0 deletions .doc/installation.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,3 +48,39 @@ END

go run main.go
------------------------------------


[discrete]
=== {es} Version Compatibility

The client major versions correspond to the {es} major versions: to connect to
{es} `7.x`, use a `7.x` version of the client, to connect to {es} `6.x`, use a
`6.x` version of the client, and so on.

[NOTE]
--
While the 5.x version of the client is available, it is no longer actively
maintained, neither the corresponding {es} version. For more information, refer
to https://www.elastic.co/support/eol[Elastic product end of life dates].
--

[%header,cols=2*]
|===
|{es} Version
|Client Version

|`master`
|`master`

|`7.x`
|`7.x`

|`6.x`
|`6.x`

|`5.x`
|`5.x`
|===

The `master` branch of the client is compatible with the `master` branch of
{es}.
13 changes: 5 additions & 8 deletions .doc/overview.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,13 @@ https://github.com/elastic/go-elasticsearch[GitHub]
and https://godoc.org/github.com/elastic/go-elasticsearch[GoDoc]. This
documentation provides only an overview of features.


[discrete]
=== {es} Version Compatibility

The client major versions correspond to the {es} major versions:
to connect to {es} `6.x`, use a `6.x` version of the client,
to connect to {es} `7.x`, use a `7.x` version of the client, and so on.
=== Features

The `master` branch of the client is compatible with the `master` branch of
{es}.
* One-to-one mapping with REST API.
* Generalized, pluggable architecture.
* Helpers for convenience.
* Rich set of examples.


[discrete]
Expand Down