From d9a1b0513b7e410db46c2892d097852cf0dd093c Mon Sep 17 00:00:00 2001 From: Marci W <333176+marciw@users.noreply.github.com> Date: Mon, 30 Sep 2024 12:07:15 -0400 Subject: [PATCH 1/3] Typos and style fixes --- docs/intro.asciidoc | 37 +++++++++++++++++-------------------- 1 file changed, 17 insertions(+), 20 deletions(-) diff --git a/docs/intro.asciidoc b/docs/intro.asciidoc index 919b9f9dff1..7fa8e117c99 100644 --- a/docs/intro.asciidoc +++ b/docs/intro.asciidoc @@ -5,34 +5,33 @@ *Rapidly develop applications with the .NET client for {es}.* -Designed for .NET client-application developers, you can utilize the .NET language client -library, which provides a strongly-typed API and query DSL to interact with {es}. -The .NET client library is designed to make it easy to use {es} from your .NET -applications. The .NET client includes higher-level abstractions, such as +Designed for .NET application developers, the .NET language client +library provides a strongly typed API and query DSL for interacting with {es}. +The .NET client includes higher-level abstractions, such as helpers for coordinating bulk indexing and update operations. It also comes with built-in, configurable cluster failover retry mechanisms. The {es} .NET client is available as a https://www.nuget.org/packages/Elastic.Clients.Elasticsearch[NuGet] -package that can be used in .NET Core, .NET 5+ and .NET Framework (4.6.1 and higher) +package for use with .NET Core, .NET 5+, and .NET Framework (4.6.1 and later) applications. -_NOTE: This documentation relates to the v8 .NET client for {es}, designed for use -with {es} 8.x versions. To develop applications targetting {es} v7, you should -use the https://www.elastic.co/guide/en/elasticsearch/client/net-api/7.17[v7 (NEST) client]._ +_NOTE: This documentation covers the v8 .NET client for {es}, designed for use +with {es} 8.x versions. To develop applications targeting {es} v7, use the +https://www.elastic.co/guide/en/elasticsearch/client/net-api/7.17[v7 (NEST) client]._ [discrete] [[features]] === Features -* One-to-one mapping with REST API. +* One-to-one mapping with the REST API. * Strongly typed requests and responses for {es} APIs. * Fluent API for building requests. * Query DSL to assist with constructing search queries. * Helpers for common tasks such as bulk indexing of documents. -* Pluggable serialization of requests and responses based on System.Text.Json. +* Pluggable serialization of requests and responses based on `System.Text.Json`. * Diagnostics, auditing, and .NET activity integration. -The .NET {es} client is built upon the Elastic Transport library which provides: +The .NET {es} client is built on the Elastic Transport library, which provides: * Connection management and load balancing across all available nodes. * Request retries and dead connections handling. @@ -40,17 +39,15 @@ The .NET {es} client is built upon the Elastic Transport library which provides: [discrete] === {es} version compatibility -Language clients are forward compatible; meaning that clients support communicating -with greater or equal minor versions of {es}. {es} language clients are only -backwards compatible with default distributions and without guarantees made. +Language clients are forward compatible: clients support communicating +with current and later minor versions of {es}. {es} language clients are +backward compatible with default distributions only and without guarantees. [discrete] === Questions, bugs, comments, feature requests -Bug reports and feature requests are more than welcome on the -{github}/issues[github issues pages]! +To submit a bug report or feature request, use +{github}/issues[GitHub issues]. -For more general questions and comments, we monitor questions and discussions -opened on our community forum, https://discuss.elastic.co/c/elasticsearch[discuss.elastic.co]. -Mentioning `.NET` in the title helps folks quickly identify what -the question is about. \ No newline at end of file +For more general questions and comments, try the community forum on https://discuss.elastic.co/c/elasticsearch[discuss.elastic.co]. +Mention `.NET` in the title to indicate the discussion topic. \ No newline at end of file From 4de5417aaa5c544e6f6f5531a2d8968a47f4c689 Mon Sep 17 00:00:00 2001 From: Marci W <333176+marciw@users.noreply.github.com> Date: Mon, 30 Sep 2024 12:19:25 -0400 Subject: [PATCH 2/3] line tweak --- docs/intro.asciidoc | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/intro.asciidoc b/docs/intro.asciidoc index 7fa8e117c99..7f12e71b7df 100644 --- a/docs/intro.asciidoc +++ b/docs/intro.asciidoc @@ -49,5 +49,6 @@ backward compatible with default distributions only and without guarantees. To submit a bug report or feature request, use {github}/issues[GitHub issues]. -For more general questions and comments, try the community forum on https://discuss.elastic.co/c/elasticsearch[discuss.elastic.co]. +For more general questions and comments, try the community forum +on https://discuss.elastic.co/c/elasticsearch[discuss.elastic.co]. Mention `.NET` in the title to indicate the discussion topic. \ No newline at end of file From 2f9e297ada394624138be1603e770d4d2ab459aa Mon Sep 17 00:00:00 2001 From: Marci W <333176+marciw@users.noreply.github.com> Date: Mon, 30 Sep 2024 12:22:22 -0400 Subject: [PATCH 3/3] One fewer word --- docs/intro.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/intro.asciidoc b/docs/intro.asciidoc index 7f12e71b7df..d638ad6acac 100644 --- a/docs/intro.asciidoc +++ b/docs/intro.asciidoc @@ -15,7 +15,7 @@ The {es} .NET client is available as a https://www.nuget.org/packages/Elastic.Cl package for use with .NET Core, .NET 5+, and .NET Framework (4.6.1 and later) applications. -_NOTE: This documentation covers the v8 .NET client for {es}, designed for use +_NOTE: This documentation covers the v8 .NET client for {es}, for use with {es} 8.x versions. To develop applications targeting {es} v7, use the https://www.elastic.co/guide/en/elasticsearch/client/net-api/7.17[v7 (NEST) client]._