Skip to content

[DOCS] Reorganizes Overview and Installation chapters in Test folder #5042

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 3, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 5 additions & 15 deletions docs/high-level.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,20 +11,12 @@ If you wish to submit a PR for any spelling mistakes, typos or grammatical error
please modify the original csharp file found at the link and submit the PR with that change. Thanks!
////

[partintro]
--
The high level client, `ElasticClient`, provides a strongly typed query DSL that maps one-to-one with the Elasticsearch query DSL.
The high level client, `ElasticClient`, provides a strongly typed query DSL that
maps one-to-one with the {es} query DSL. Please refer to <<es-nest>> for
installation details.

It can be installed from the Package Manager Console inside Visual Studio using

[source,shell]
----
Install-Package NEST
----

Or by searching for https://www.nuget.org/packages/NEST[NEST] in the Package Manager GUI.

NEST internally uses and still exposes the low level client, `ElasticLowLevelClient`, from <<elasticsearch-net,Elasticsearch.Net>> via
NEST internally uses and still exposes the low level client,
`ElasticLowLevelClient`, from <<elasticsearch-net,Elasticsearch.Net>> via
the `.LowLevel` property on `ElasticClient`.

There are a number of conventions that NEST uses for inference of
Expand Down Expand Up @@ -57,8 +49,6 @@ And features such as

* <<covariant-search-results, Covariant Search Results>>

--

include::{output-dir}/getting-started.asciidoc[]

[[connecting]]
Expand Down
4 changes: 3 additions & 1 deletion docs/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@ If you wish to submit a PR for any spelling mistakes, typos or grammatical error
please modify the original csharp file found at the link and submit the PR with that change. Thanks!
////

include::intro.asciidoc[]
include::introduction.asciidoc[]

include::installation.asciidoc[]

include::breaking-changes.asciidoc[]

Expand Down
56 changes: 56 additions & 0 deletions docs/installation.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
////
IMPORTANT NOTE
==============
This file has been generated from https://github.com/elastic/elasticsearch-net/tree/master/src/Tests/Tests/installation.asciidoc.
If you wish to submit a PR for any spelling mistakes, typos or grammatical errors for this file,
please modify the original csharp file found at the link and submit the PR with that change. Thanks!
////

[[installation]]
== Installation

This page is about about how to install the `Elasticsearch.Net` and the `NEST`
clients.

[[es-net]]
[discrete]
=== Installing the Elasticsearch.Net client

The low level client, `ElasticLowLevelClient`, is a low level, dependency free
client that has no opinions about how you build and represent your requests and
responses.

It can be installed from the Package Manager Console inside Visual Studio by
using the following command:

[source,shell]
----
Install-Package Elasticsearch.Net
----

Or by searching for
https://www.nuget.org/packages/Elasticsearch.Net[Elasticsearch.Net] in the
Package Manager GUI.

[[es-nest]]
[discrete]
=== Installing the NEST client

The high level `ElasticClient`, provides a strongly typed query DSL that maps
one-to-one with the {es} query DSL.

It can be installed from the Package Manager Console inside Visual Studio by
using the following command:

[source,shell]
----
Install-Package NEST
----

Or by searching for https://www.nuget.org/packages/NEST[NEST] in the Package
Manager GUI.

NEST internally uses and still exposes the low level client,
`ElasticLowLevelClient`, from <<elasticsearch-net,Elasticsearch.Net>> via the
`.LowLevel` property on `ElasticClient`.

43 changes: 0 additions & 43 deletions docs/intro.asciidoc

This file was deleted.

54 changes: 54 additions & 0 deletions docs/introduction.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
:github: https://github.com/elastic/elasticsearch-net

:stackoverflow: http://stackoverflow.com

////
IMPORTANT NOTE
==============
This file has been generated from https://github.com/elastic/elasticsearch-net/tree/master/src/Tests/Tests/introduction.asciidoc.
If you wish to submit a PR for any spelling mistakes, typos or grammatical errors for this file,
please modify the original csharp file found at the link and submit the PR with that change. Thanks!
////

[[introduction]]
== Introduction

This is the documentation page for `Elasticsearch.Net` and `NEST`, the two
official .NET clients for {es}.

[discrete]
=== Why two clients?

`Elasticsearch.Net` is a low level, dependency free client that has no opinions
about how you build and represent your requests and responses. It has abstracted
enough so that **all** the {es} API endpoints are represented as methods but not
too much to get in the way of how you want to build your json/request/response
objects. It also comes with built in, configurable/overridable cluster failover
retry mechanisms. {es} is _elastic_ so why not your client?

`NEST` is a high level client that maps all requests and responses as types, and
comes with a strongly typed query DSL that maps 1 to 1 with the {es} query DSL.
It takes advantage of specific .NET features to provide higher level
abstractions such as <<auto-map, auto mapping of CLR types>>. Internally, NEST
uses and still exposes the low level `Elasticsearch.Net` client, providing
access to the power of NEST and allowing users to drop down to the low level
client when wishing to.

Please read the getting started guide for both
<<elasticsearch-net,Elasticsearch.Net>> and <<nest,NEST>>.

[discrete]
=== Questions, bugs, comments, feature requests

Bug reports and feature requests are more than welcome on the
{github}/issues[github issues pages]! We try to at least reply within the same
day.

For more general questions and comments, we monitor questions tagged with
{stackoverflow}/questions/tagged/nest[`nest`] and
{stackoverflow}/questions/tagged/elasticsearch-net[`elasticsearch-net`] on
Stackoverflow, as well as discussions opened on our Discourse site,
https://discuss.elastic.co/c/elasticsearch[discuss.elastic.co]. By mentioning
`NEST` or `Elasticsearch.Net` in the title helps folks quickly identify what
the question is about.

18 changes: 3 additions & 15 deletions docs/low-level.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,21 +9,9 @@ If you wish to submit a PR for any spelling mistakes, typos or grammatical error
please modify the original csharp file found at the link and submit the PR with that change. Thanks!
////

[partintro]
--
The low level client, `ElasticLowLevelClient`, is a low level, dependency free client that has no
opinions about how you build and represent your requests and responses.

It can be installed from the Package Manager Console inside Visual Studio using

[source,shell]
----
Install-Package Elasticsearch.Net
----

Or by searching for https://www.nuget.org/packages/Elasticsearch.Net[Elasticsearch.Net] in the Package Manager GUI.

--
The low level client, `ElasticLowLevelClient`, is a low level, dependency free
client that has no opinions about how you build and represent your requests and
responses. Please refer to <<es-net>> for installation details.

include::client-concepts/low-level/getting-started.asciidoc[]

Expand Down
20 changes: 5 additions & 15 deletions tests/Tests/high-level.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,12 @@
[[nest]]
= NEST - High level client

[partintro]
--
The high level client, `ElasticClient`, provides a strongly typed query DSL that maps one-to-one with the Elasticsearch query DSL.
The high level client, `ElasticClient`, provides a strongly typed query DSL that
maps one-to-one with the {es} query DSL. Please refer to <<es-nest>> for
installation details.

It can be installed from the Package Manager Console inside Visual Studio using

[source, shell]
----
Install-Package NEST
----

Or by searching for https://www.nuget.org/packages/NEST[NEST] in the Package Manager GUI.

NEST internally uses and still exposes the low level client, `ElasticLowLevelClient`, from <<elasticsearch-net,Elasticsearch.Net>> via
NEST internally uses and still exposes the low level client,
`ElasticLowLevelClient`, from <<elasticsearch-net,Elasticsearch.Net>> via
the `.LowLevel` property on `ElasticClient`.

There are a number of conventions that NEST uses for inference of
Expand All @@ -40,8 +32,6 @@ And features such as
- <<mapping, Mapping CLR POCO types to JSON documents>>
- <<covariant-search-results, Covariant Search Results>>

--

include::{output-dir}/getting-started.asciidoc[]

[[connecting]]
Expand Down
4 changes: 3 additions & 1 deletion tests/Tests/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@
[[elasticsearch-net-reference]]
= Elasticsearch.Net and NEST: the .NET clients

include::intro.asciidoc[]
include::introduction.asciidoc[]

include::installation.asciidoc[]

include::breaking-changes.asciidoc[]

Expand Down
48 changes: 48 additions & 0 deletions tests/Tests/installation.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
[[installation]]
== Installation

This page is about about how to install the `Elasticsearch.Net` and the `NEST`
clients.

[discrete]
[[es-net]]
=== Installing the Elasticsearch.Net client

The low level client, `ElasticLowLevelClient`, is a low level, dependency free
client that has no opinions about how you build and represent your requests and
responses.

It can be installed from the Package Manager Console inside Visual Studio by
using the following command:

[source,shell]
----
Install-Package Elasticsearch.Net
----

Or by searching for
https://www.nuget.org/packages/Elasticsearch.Net[Elasticsearch.Net] in the
Package Manager GUI.


[discrete]
[[es-nest]]
=== Installing the NEST client

The high level `ElasticClient`, provides a strongly typed query DSL that maps
one-to-one with the {es} query DSL.

It can be installed from the Package Manager Console inside Visual Studio by
using the following command:

[source,shell]
----
Install-Package NEST
----

Or by searching for https://www.nuget.org/packages/NEST[NEST] in the Package
Manager GUI.

NEST internally uses and still exposes the low level client,
`ElasticLowLevelClient`, from <<elasticsearch-net,Elasticsearch.Net>> via the
`.LowLevel` property on `ElasticClient`.
33 changes: 0 additions & 33 deletions tests/Tests/intro.asciidoc

This file was deleted.

Loading