Skip to content

Commit

Permalink
[DOCS] Adds getting started content based on the template.
Browse files Browse the repository at this point in the history
  • Loading branch information
szabosteve committed Jul 3, 2023
1 parent 3183cb5 commit 208777e
Show file tree
Hide file tree
Showing 4 changed files with 134 additions and 1 deletion.
133 changes: 133 additions & 0 deletions docs/guide/getting-started.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@
[[getting-started-python]]
== Getting started

This page guides you through the installation process of the Python 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,py]
----
----

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,py]
----
----


[discrete]
==== Indexing documents

This is a simple way of indexing a document:

[source,py]
----
----


[discrete]
==== Getting documents

You can get documents by using the following code:

[source,py]
----
----


[discrete]
==== Searching documents

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

[source,py]
----
----


[discrete]
==== Updating documents

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

[source,py]
----
----


[discrete]
==== Deleting documents

[source,py]
----
----


[discrete]
==== Deleting an index

[source,py]
----
----


[discrete]
== Further reading

* Use <<client-helpers>> for a more comfortable experience with the APIs.
Binary file added docs/guide/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/guide/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: 1 addition & 1 deletion docs/guide/index-custom-title-page.html
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ <h2>Documentation</h2>
The official Python client provides one-to-one mapping with Elasticsearch REST APIs.
</p>
<p>
<a href="https://www.elastic.co/guide/en/elasticsearch/client/python-api/current/overview.html">
<a href="https://www.elastic.co/guide/en/elasticsearch/client/python-api/current/getting-started-python.html">
<button class="btn btn-primary">Get started</button>
</a>
</p>
Expand Down

0 comments on commit 208777e

Please sign in to comment.