diff --git a/README.md b/README.md index c2cd477b6cc..90a662fa6c4 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,3 @@ -Elastic logo - Repository for **Elastic.Clients.Elasticsearch** the official .NET client for [Elasticsearch](https://github.com/elastic/elasticsearch). *Older branches include both previous clients, **NEST** and **Elasticsearch.Net**.* The .NET client for Elasticsearch provides strongly typed requests and responses for Elasticsearch APIs. It delegates protocol handling to the [Elastic.Transport](https://github.com/elastic/elastic-transport-net) library, which takes care of all transport-level concerns (HTTP connection establishment and pooling, retries, etc.). @@ -12,17 +10,18 @@ Language clients are forward compatible; meaning that clients support communicat ### Elasticsearch 8.x Clusters -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. +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 +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. -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. +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. ### Elasticsearch 7.x Clusters -We recommend using the latest `7.17.x` client to communicate with Elasticsearch v7 servers. +We recommend using the latest `7.17.x` [NEST client](https://www.nuget.org/packages/Nest) to communicate with Elasticsearch v7 servers. ## Documentation -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. +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. ## Contributing diff --git a/docs/install.asciidoc b/docs/install.asciidoc index 6dccb17a038..f72fd518fec 100644 --- a/docs/install.asciidoc +++ b/docs/install.asciidoc @@ -3,12 +3,12 @@ This page shows you how to install the .NET client for {es}. -IMPORTANT: The v8 client for .NET is currently in pre-release and not supported for -production use. We provide it for testing and migration planning purposes. -You may continue to use the 7.17.x release of the client to communicate with v8 +IMPORTANT: The v8 client for .NET does not have complete feature parity with +the v7 `NEST` client. It may not be suitable for for all applications until +additional endpoints and features are supported. We therefore recommend you thoroughly review our <> before attempting to migrate existing applications to the `Elastic.Clients.Elasticsearch` library. Until the new client supports all endpoints and features your application requires, +you may continue to use the 7.17.x release of the client to communicate with v8 Elasticsearch servers using compatibility mode. Refer to the -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. +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. [discrete] [[dot-net-client]] @@ -19,7 +19,7 @@ For SDK style projects, you can install the {es} client by running the following [source,text] ---- -dotnet add package Elastic.Clients.Elasticsearch --prerelease +dotnet add package Elastic.Clients.Elasticsearch ---- This command adds a package reference to your project (csproj) file for the @@ -30,27 +30,22 @@ file: [source,shell] ---- - + ---- - -To install a different version, modify the version as necessary. During the prerelease -phase, we highly recommend using the latest pre-release version. +_NOTE: The version number should reflect the latest published version from +https://www.nuget.org/packages/Elastic.Clients.Elasticsearch[NuGet.org]. To install a different version, modify the version as necessary._ For Visual Studio users, the .NET client can also be installed from the Package Manager Console inside Visual Studio using the following command: [source,shell] ---- -Install-Package Elastic.Clients.Elasticsearch -IncludePrerelease +Install-Package Elastic.Clients.Elasticsearch ---- Alternatively, search for `Elastic.Clients.Elasticsearch` in the NuGet Package Manager UI. -NOTE: By default, NuGet does not include pre-release versions when working with packages, -but you can change this behavior by checking the "Include prerelease" option in the -Package Manager UI. - To learn how to connect the {es} client, refer to the <> section. [discrete] diff --git a/docs/release-notes/release-notes-8.0.0.asciidoc b/docs/release-notes/release-notes-8.0.0.asciidoc index 31b4149f077..5ab8ff266fc 100644 --- a/docs/release-notes/release-notes-8.0.0.asciidoc +++ b/docs/release-notes/release-notes-8.0.0.asciidoc @@ -84,7 +84,7 @@ automatically code-generated from a https://github.com/elastic/elasticsearch-spe client and server among SDKs and libraries, such as those for Azure, AWS and the Google Cloud Platform. -code-generation from a specification has inevitably led to some differences +Code-generation from a specification has inevitably led to some differences between the existing v7 `NEST` types and those available in the new v7 {net-client}. For the 8.0.0 release, we generate strictly from the specification, special casing a few areas to improve usability or to align with language idioms. diff --git a/src/Elastic.Clients.Elasticsearch/Elastic.Clients.Elasticsearch.csproj b/src/Elastic.Clients.Elasticsearch/Elastic.Clients.Elasticsearch.csproj index 70908f8ab1d..288fae59f3a 100644 --- a/src/Elastic.Clients.Elasticsearch/Elastic.Clients.Elasticsearch.csproj +++ b/src/Elastic.Clients.Elasticsearch/Elastic.Clients.Elasticsearch.csproj @@ -7,6 +7,7 @@ This strongly-typed, client library enables working with Elasticsearch. It is the official client maintained and supported by Elastic. true + README.md true @@ -34,6 +35,6 @@ - + \ No newline at end of file