Skip to content

Commit e279b7e

Browse files
fix image paths for docs-assembler (#2654)
1 parent a69cf84 commit e279b7e

File tree

3 files changed

+12
-30
lines changed

3 files changed

+12
-30
lines changed

docs/reference/connecting.md

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,7 @@ This document contains code snippets to show you how to connect to various {{es}
1616

1717
If you are using [Elastic Cloud](https://www.elastic.co/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.
1818

19-
:::{image} images/cloud_id.png
20-
:alt: Cloud ID
21-
:::
19+
![Cloud ID](images/cloud_id.png)
2220

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

@@ -34,21 +32,15 @@ client = Elasticsearch::Client.new(
3432

3533
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`.
3634

37-
:::{image} images/cloud_api_key.png
38-
:alt: API key
39-
:::
35+
![API key](images/cloud_api_key.png)
4036

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

43-
:::{image} images/api_key_name.png
44-
:alt: Choose an API name
45-
:::
39+
![Choose an API name](images/api_key_name.png)
4640

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

49-
:::{image} images/cloud_api_key.png
50-
:alt: API key
51-
:::
43+
![API key](images/cloud_api_key.png)
5244

5345
**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.
5446

docs/reference/getting-started.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,15 +38,11 @@ client = Elasticsearch::Client.new(
3838

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

41-
:::{image} images/es_endpoint.jpg
42-
:alt: Finding Elasticsearch endpoint
43-
:::
41+
![Finding Elasticsearch endpoint](images/es_endpoint.jpg)
4442

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

47-
:::{image} images/create_api_key.png
48-
:alt: Create API key
49-
:::
45+
![Create API key](images/create_api_key.png)
5046

5147
For other connection options, refer to the [*Connecting*](/reference/connecting.md) section.
5248

docs/reference/opentelemetry.md

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,24 +9,18 @@ You can use [OpenTelemetry](https://opentelemetry.io/) to monitor the performanc
99

1010
The native instrumentation in the Ruby Client follows the [OpenTelemetry Semantic Conventions for {{es}}](https://opentelemetry.io/docs/specs/semconv/database/elasticsearch/). In particular, the instrumentation in the client covers the logical layer of {{es}} requests. A single span per request is created that is processed by the service through the Ruby Client. The following image shows a trace that records the handling of two different {{es}} requests: a `ping` request and a `search` request.
1111

12-
:::{image} images/otel-waterfall-without-http.png
13-
:alt: Distributed trace with Elasticsearch spans
14-
:class: screenshot
15-
:::
12+
% TO DO: Use `:class: screenshot`
13+
![Distributed trace with Elasticsearch spans](images/otel-waterfall-without-http.png)
1614

1715
Usually, OpenTelemetry auto-instrumentation modules come with instrumentation support for HTTP-level communication. In this case, in addition to the logical {{es}} client requests, spans will be captured for the physical HTTP requests emitted by the client. The following image shows a trace with both, {{es}} spans (in blue) and the corresponding HTTP-level spans (in red):
1816

19-
:::{image} images/otel-waterfall-with-http.png
20-
:alt: Distributed trace with Elasticsearch spans
21-
:class: screenshot
22-
:::
17+
% TO DO: Use `:class: screenshot`
18+
![Distributed trace with Elasticsearch spans](images/otel-waterfall-with-http.png)
2319

2420
Advanced Ruby Client behavior such as nodes round-robin and request retries are revealed through the combination of logical {{es}} spans and the physical HTTP spans. The following example shows a `search` request in a scenario with two nodes:
2521

26-
:::{image} images/otel-waterfall-retry.png
27-
:alt: Distributed trace with Elasticsearch spans
28-
:class: screenshot
29-
:::
22+
% TO DO: Use `:class: screenshot`
23+
![Distributed trace with Elasticsearch spans](images/otel-waterfall-retry.png)
3024

3125
The first node is unavailable and results in an HTTP error, while the retry to the second node succeeds. Both HTTP requests are subsumed by the logical {{es}} request span (in blue).
3226

0 commit comments

Comments
 (0)