Skip to content

Commit 3d4fd21

Browse files
Update readme and docs (#7024) (#7030)
* Update install documentation * Fix release notes * Update readme * Add readme to NuGet package Co-authored-by: Steve Gordon <[email protected]>
1 parent 7db1344 commit 3d4fd21

File tree

4 files changed

+18
-21
lines changed

4 files changed

+18
-21
lines changed

README.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,18 @@ Language clients are forward compatible; meaning that clients support communicat
1212

1313
### Elasticsearch 8.x Clusters
1414

15-
We are actively working on the next generation of the .NET client for Elasticsearch, which aligns with v8 of Elasticsearch. We have renamed this library `Elastic.Clients.Elasticsearch`, and the packages are published on [NuGet](https://www.nuget.org/packages/Elastic.Clients.Elasticsearch/). The new client is in pre-release with beta versions available to install. We do not recommend using the pre-release versions in production.
15+
We have released the next generation of the .NET client for Elasticsearch, which aligns with v8 of Elasticsearch. We have renamed this library `Elastic.Clients.Elasticsearch`, and the packages are published on [NuGet](https://www.nuget.org/packages/Elastic.Clients.Elasticsearch/). The 8.0.x versions do not offer complete
16+
feature parity with the exitsing `NEST` client. We therefore recommend you thoroughly review our [release notes and migration guidance](https://elasticsearch-net_7008.docs-preview.app.elstc.co/guide/en/elasticsearch/client/net-api/current/release-notes-8.0.0.html) before attempting to migrate existing applications to the `Elastic.Clients.Elasticsearch` library.
1617

17-
Until the GA release of the new client, you may continue to use the latest `7.17.x` client to communicate with Elasticsearch v8 servers. Please review [our documentation](https://www.elastic.co/guide/en/elasticsearch/client/net-api/7.17/connecting-to-elasticsearch-v8.html), which describes how to enable compatibility mode and secure communications with a v8 cluster.
18+
Until the new client supports all endpoints and features your application requires, you may continue to use the latest `7.17.x` client to communicate with Elasticsearch v8 servers. Please review [our documentation](https://www.elastic.co/guide/en/elasticsearch/client/net-api/7.17/connecting-to-elasticsearch-v8.html), which describes how to enable compatibility mode and secure communications with a v8 cluster.
1819

1920
### Elasticsearch 7.x Clusters
2021

21-
We recommend using the latest `7.17.x` client to communicate with Elasticsearch v7 servers.
22+
We recommend using the latest `7.17.x` [NEST client](https://www.nuget.org/packages/Nest) to communicate with Elasticsearch v7 servers.
2223

2324
## Documentation
2425

25-
Please refer to [the full documentation on elastic.co](https://www.elastic.co/guide/en/elasticsearch/client/net-api/current/index.html) for comprehensive information.
26+
Please refer to [the full documentation on elastic.co](https://www.elastic.co/guide/en/elasticsearch/client/net-api/current/index.html) for comprehensive information on installation, configuration and usage.
2627

2728
## Contributing
2829

docs/install.asciidoc

+10-15
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@
33

44
This page shows you how to install the .NET client for {es}.
55

6-
IMPORTANT: The v8 client for .NET is currently in pre-release and not supported for
7-
production use. We provide it for testing and migration planning purposes.
8-
You may continue to use the 7.17.x release of the client to communicate with v8
6+
IMPORTANT: The v8 client for .NET does not have complete feature parity with
7+
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-8.0.0,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
910
Elasticsearch servers using compatibility mode. Refer to the
10-
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]
11-
for guidance on configuring the 7.17.x client.
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.
1212

1313
[discrete]
1414
[[dot-net-client]]
@@ -19,7 +19,7 @@ For SDK style projects, you can install the {es} client by running the following
1919

2020
[source,text]
2121
----
22-
dotnet add package Elastic.Clients.Elasticsearch --prerelease
22+
dotnet add package Elastic.Clients.Elasticsearch
2323
----
2424

2525
This command adds a package reference to your project (csproj) file for the
@@ -30,27 +30,22 @@ file:
3030

3131
[source,shell]
3232
----
33-
<PackageReference Include="Elastic.Clients.Elasticsearch" Version="8.0.0-alpha.5" />
33+
<PackageReference Include="Elastic.Clients.Elasticsearch" Version="8.0.0" />
3434
----
35-
36-
To install a different version, modify the version as necessary. During the prerelease
37-
phase, we highly recommend using the latest pre-release version.
35+
_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._
3837

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

4241
[source,shell]
4342
----
44-
Install-Package Elastic.Clients.Elasticsearch -IncludePrerelease
43+
Install-Package Elastic.Clients.Elasticsearch
4544
----
4645

4746
Alternatively, search for `Elastic.Clients.Elasticsearch` in the NuGet Package
4847
Manager UI.
4948

50-
NOTE: By default, NuGet does not include pre-release versions when working with packages,
51-
but you can change this behavior by checking the "Include prerelease" option in the
52-
Package Manager UI.
53-
5449
To learn how to connect the {es} client, refer to the <<connecting,Connecting>> section.
5550

5651
[discrete]

docs/release-notes/release-notes-8.0.0.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ automatically code-generated from a https://github.com/elastic/elasticsearch-spe
8484
client and server among SDKs and libraries, such as those for Azure, AWS and the
8585
Google Cloud Platform.
8686

87-
code-generation from a specification has inevitably led to some differences
87+
Code-generation from a specification has inevitably led to some differences
8888
between the existing v7 `NEST` types and those available in the new v7 {net-client}.
8989
For the 8.0.0 release, we generate strictly from the specification, special
9090
casing a few areas to improve usability or to align with language idioms.

src/Elastic.Clients.Elasticsearch/Elastic.Clients.Elasticsearch.csproj

+2-1
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
This strongly-typed, client library enables working with Elasticsearch. It is the official client maintained and supported by Elastic.
88
</Description>
99
<ProduceReferenceAssembly>true</ProduceReferenceAssembly>
10+
<PackageReadmeFile>README.md</PackageReadmeFile>
1011
</PropertyGroup>
1112
<PropertyGroup>
1213
<IsPackable>true</IsPackable>
@@ -34,6 +35,6 @@
3435
</AssemblyAttribute>
3536
</ItemGroup>
3637
<ItemGroup>
37-
<Folder Include="Types\Documents\" />
38+
<None Include="..\..\README.md" Pack="true" PackagePath="\"/>
3839
</ItemGroup>
3940
</Project>

0 commit comments

Comments
 (0)