Skip to content
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.

Sign up for GitHub

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

[Backport][8.14][DOCS] Restructure helper docs for ES|QL GA (#2399) #2412

Merged
merged 2 commits into from
Jun 6, 2024
Merged

[Backport][8.14][DOCS] Restructure helper docs for ES|QL GA (#2399) #2412

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
45356a0
[DOCS] Restructure helper docs for ES|QL GA (#2399)
marciw Jun 6, 2024
1cb7618
[DOCS] Updates link to ES|QL helper docs
picandocodigo Jun 6, 2024
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
8 changes: 4 additions & 4 deletions docs/connecting.asciidoc
View file
Open in desktop
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
View file
Open in desktop

This file was deleted.

Loading
Loading