Skip to content

Commit 152864b

Browse files
committed
[DOCS] Adds Features subsection to Overview (#195)
1 parent 17c9104 commit 152864b

File tree

2 files changed

+41
-8
lines changed

2 files changed

+41
-8
lines changed

.doc/installation.asciidoc

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,3 +48,39 @@ END
4848
4949
go run main.go
5050
------------------------------------
51+
52+
53+
[discrete]
54+
=== {es} Version Compatibility
55+
56+
The client major versions correspond to the {es} major versions: to connect to
57+
{es} `7.x`, use a `7.x` version of the client, to connect to {es} `6.x`, use a
58+
`6.x` version of the client, and so on.
59+
60+
[NOTE]
61+
--
62+
While the 5.x version of the client is available, it is no longer actively
63+
maintained, neither the corresponding {es} version. For more information, refer
64+
to https://www.elastic.co/support/eol[Elastic product end of life dates].
65+
--
66+
67+
[%header,cols=2*]
68+
|===
69+
|{es} Version
70+
|Client Version
71+
72+
|`master`
73+
|`master`
74+
75+
|`7.x`
76+
|`7.x`
77+
78+
|`6.x`
79+
|`6.x`
80+
81+
|`5.x`
82+
|`5.x`
83+
|===
84+
85+
The `master` branch of the client is compatible with the `master` branch of
86+
{es}.

.doc/overview.asciidoc

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,13 @@ https://github.com/elastic/go-elasticsearch[GitHub]
88
and https://godoc.org/github.com/elastic/go-elasticsearch[GoDoc]. This
99
documentation provides only an overview of features.
1010

11-
1211
[discrete]
13-
=== {es} Version Compatibility
14-
15-
The client major versions correspond to the {es} major versions:
16-
to connect to {es} `6.x`, use a `6.x` version of the client,
17-
to connect to {es} `7.x`, use a `7.x` version of the client, and so on.
12+
=== Features
1813

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

2219

2320
[discrete]

0 commit comments

Comments
 (0)