Skip to content
Merged
134 changes: 134 additions & 0 deletions docs/getting-started.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@
[[getting-started-net]]
== Getting started

This page guides you through the installation process of the .NET client, shows
you how to instantiate the client, and how to perform basic Elasticsearch
operations with it.

[discrete]
=== Requirements

* (...)

[discrete]
=== Installation

To install the latest version of the client, run the following command:

[source,shell]
--------------------------

--------------------------

Refer to the <<installation>> page to learn more.


[discrete]
=== Connecting

You can connect to the Elastic Cloud using an API key and the Elasticsearch
endpoint.

[source,net]
----

----

Your Elasticsearch endpoint can be found on the **My deployment** page of your
deployment:

image::images/es-endpoint.jpg[alt="Finding Elasticsearch endpoint",align="center"]

You can generate an API key on the **Management** page under Security.

image::images/create-api-key.png[alt="Create API key",align="center"]

For other connection options, refer to the <<connecting>> section.


[discrete]
=== Operations

Time to use Elasticsearch! This section walks you through the basic, and most
important, operations of Elasticsearch. For more operations and more advanced
examples, refer to the <<examples>> page.


[discrete]
==== Creating an index

This is how you create the `my_index` index:

[source,net]
----

----


[discrete]
==== Indexing documents

This is a simple way of indexing a document:

[source,net]
----

----


[discrete]
==== Getting documents

You can get documents by using the following code:

[source,net]
----

----


[discrete]
==== Searching documents

This is how you can create a single match query with the .NET client:

[source,net]
----

----


[discrete]
==== Updating documents

This is how you can update a document, for example to add a new field:

[source,net]
----

----


[discrete]
==== Deleting documents

[source,net]
----

----


[discrete]
==== Deleting an index

[source,net]
----

----


[discrete]
== Further reading

* Refer to the <<recommendations>> page to learn more about how to use the
client the most efficiently.
Binary file added docs/images/create-api-key.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/es-endpoint.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions docs/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[]

include::intro.asciidoc[]

include::getting-started.asciidoc[]

include::install.asciidoc[]

include::connecting.asciidoc[]
Expand Down