Skip to content

Commit ef696fe

Browse files
Improve introduction documentation (#7652) (#7659)
Co-authored-by: Steve Gordon <[email protected]>
1 parent f45cb3e commit ef696fe

File tree

3 files changed

+49
-9
lines changed

3 files changed

+49
-9
lines changed

docs/index.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ include::{asciidoc-dir}/../../shared/versions/stack/{source_branch}.asciidoc[]
55
include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
66

77
:doc-tests-src: {docdir}/../tests/Tests/Documentation
8-
98
:net-client: Elasticsearch .NET Client
9+
:latest-version: 8.1.0
1010

1111
include::intro.asciidoc[]
1212

docs/install.asciidoc

+11-6
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,14 @@ This page shows you how to install the .NET client for {es}.
55

66
IMPORTANT: The v8 client for .NET does not have complete feature parity with
77
the v7 `NEST` client. It may not be suitable for for all applications until
8-
additional endpoints and features are supported. We therefore recommend you thoroughly review our <<release-notes,release notes>> before attempting to migrate existing applications to the `Elastic.Clients.Elasticsearch` library. Until the new client supports all endpoints and features your application requires,
9-
you may continue to use the 7.17.x release of the client to communicate with v8
10-
Elasticsearch servers using compatibility mode. Refer to the
11-
https://www.elastic.co/guide/en/elasticsearch/client/net-api/7.17/connecting-to-elasticsearch-v8.html[Connecting to Elasticsearch v8.x using the v7.17.x client documentation] for guidance on configuring the 7.17.x client.
8+
additional endpoints and features are supported. We therefore recommend you thoroughly
9+
review our <<release-notes,release notes>> before attempting to migrate
10+
existing applications to the `Elastic.Clients.Elasticsearch` library.
11+
Until the new client supports all endpoints and features your application requires,
12+
you may continue to use the 7.17.x https://www.nuget.org/packages/NEST[NEST] client
13+
to communicate with v8 Elasticsearch servers using compatibility mode. Refer to the
14+
https://www.elastic.co/guide/en/elasticsearch/client/net-api/7.17/connecting-to-elasticsearch-v8.html[Connecting to Elasticsearch v8.x using the v7.17.x client documentation]
15+
for guidance on configuring the 7.17.x client.
1216

1317
[discrete]
1418
[[dot-net-client]]
@@ -30,10 +34,11 @@ file:
3034

3135
[source,shell]
3236
----
33-
<PackageReference Include="Elastic.Clients.Elasticsearch" Version="8.0.0" />
37+
<PackageReference Include="Elastic.Clients.Elasticsearch" Version="{latest-version}" />
3438
----
3539
_NOTE: The version number should reflect the latest published version from
36-
https://www.nuget.org/packages/Elastic.Clients.Elasticsearch[NuGet.org]. To install a different version, modify the version as necessary._
40+
https://www.nuget.org/packages/Elastic.Clients.Elasticsearch[NuGet.org]. To install
41+
a different version, modify the version as necessary._
3742

3843
For Visual Studio users, the .NET client can also be installed from the Package
3944
Manager Console inside Visual Studio using the following command:

docs/intro.asciidoc

+37-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,24 @@
1+
:github: https://github.com/elastic/elasticsearch-net
2+
13
[[introduction]]
24
== Introduction
35

4-
This is the documentation for the .NET client for {es}. This page gives you a
5-
quick overview of the main features of the client.
6+
*Rapidly develop applications with the .NET client for {es}.*
7+
8+
Designed for .NET client-application developers, you can utilize the .NET language client
9+
library, which provides a strongly-typed API and query DSL to interact with {es}.
10+
The .NET client library is designed to make it easy to use {es} from your .NET
11+
applications. The .NET client includes higher-level abstractions, such as
12+
helpers for coordinating bulk indexing and update operations. It also comes with
13+
built-in, configurable cluster failover retry mechanisms.
14+
15+
The {es} .NET client is available as a https://www.nuget.org/packages/Elastic.Clients.Elasticsearch[NuGet]
16+
package that can be used in .NET Core, .NET 5+ and .NET Framework (4.6.1 and higher)
17+
applications.
18+
19+
_NOTE: This documentation relates to the v8 .NET client for {es}, designed for use
20+
with {es} 8.x versions. To develop applications targetting {es} v7, you should
21+
use the https://www.elastic.co/guide/en/elasticsearch/client/net-api/7.17[v7 (NEST) client]._
622

723
[discrete]
824
[[features]]
@@ -11,6 +27,7 @@ quick overview of the main features of the client.
1127
* One-to-one mapping with REST API.
1228
* Strongly typed requests and responses for {es} APIs.
1329
* Fluent API for building requests.
30+
* Query DSL to assist with constructing search queries.
1431
* Helpers for common tasks such as bulk indexing of documents.
1532
* Pluggable serialization of requests and responses based on System.Text.Json.
1633
* Diagnostics, auditing, and .NET activity integration.
@@ -19,3 +36,21 @@ The .NET {es} client is built upon the Elastic Transport library which provides:
1936

2037
* Connection management and load balancing across all available nodes.
2138
* Request retries and dead connections handling.
39+
40+
[discrete]
41+
=== {es} version compatibility
42+
43+
Language clients are forward compatible; meaning that clients support communicating
44+
with greater or equal minor versions of {es}. {es} language clients are only
45+
backwards compatible with default distributions and without guarantees made.
46+
47+
[discrete]
48+
=== Questions, bugs, comments, feature requests
49+
50+
Bug reports and feature requests are more than welcome on the
51+
{github}/issues[github issues pages]!
52+
53+
For more general questions and comments, we monitor questions and discussions
54+
opened on our community forum, https://discuss.elastic.co/c/elasticsearch[discuss.elastic.co].
55+
Mentioning `.NET` in the title helps folks quickly identify what
56+
the question is about.

0 commit comments

Comments
 (0)