Skip to content

Commit

Permalink
[DOCS] Restructure helper docs for ES|QL GA (#2399)
Browse files Browse the repository at this point in the history
  • Loading branch information
marciw authored and picandocodigo committed Jun 6, 2024
1 parent 49aead1 commit fd3003b
Show file tree
Hide file tree
Showing 6 changed files with 308 additions and 262 deletions.
8 changes: 4 additions & 4 deletions docs/connecting.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ This document contains code snippets to show you how to connect to various {es}

If you are using https://www.elastic.co/cloud[Elastic Cloud], the client offers an easy way to connect to it. You need the Cloud ID that you can find in the cloud console, then your username and password.

image::docs/images/cloud_id.png["Cloud ID"]
image::images/cloud_id.png["Cloud ID"]

Once you have collected the Cloud ID you can use the client to connect to your Elastic Cloud instance, as follows:

Expand All @@ -40,15 +40,15 @@ client = Elasticsearch::Client.new(

You can also connect to the Cloud by using API Key authentication. You can generate an `API key` in the `Management` page under the section `Security`.

image::docs/images/cloud_api_key.png["API key"]
image::images/cloud_api_key.png["API key"]

When you click on `Create API key` you can choose a name and set the other options (eg. restrict privileges, expire after time, etc).

image::docs/images/api_key_name.png["Choose an API name"]
image::images/api_key_name.png["Choose an API name"]

After this step you will get the `API key` in the API keys page.

image::docs/images/cloud_api_key.png["API key"]
image::images/cloud_api_key.png["API key"]

**IMPORTANT**: you need to copy and store the `API key` in a secure place, since you will not be able to view it again in Elastic Cloud.

Expand Down
257 changes: 0 additions & 257 deletions docs/helpers.asciidoc

This file was deleted.

Loading

0 comments on commit fd3003b

Please sign in to comment.