Skip to content

Commit

Permalink
[DOCS] Adds Features subsection to Overview (elastic#195)
Browse files Browse the repository at this point in the history
  • Loading branch information
szabosteve authored Nov 4, 2020
1 parent 33d275b commit 2e1f801
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 8 deletions.
36 changes: 36 additions & 0 deletions .doc/installation.asciidoc
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
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

0 comments on commit 2e1f801

Please sign in to comment.