Changed markdown image tag to Frame (#649) (#650)

Fixed : #649 Co-authored-by: Amir Blum <amirgiraffe@gmail.com>
odigos-io · Oct 18, 2023 · 7863127 · 7863127
1 parent 4f2bed8
commit 7863127
Show file tree

Hide file tree

Showing 7 changed files with 50 additions and 14 deletions.
diff --git a/docs/architecture.mdx b/docs/architecture.mdx
@@ -34,7 +34,9 @@ The different microservices communicate via Kubernetes API server (see
 
 The following diagram shows the architecture of the Odigos observability system.
 
-![Odigos Architecture](/images/Odigos_Arch.jpeg)
+<Frame>
+    <img src="/images/Odigos_Arch.jpeg" alt="Odigos Architecture" />
+</Frame>
 
 ## Instrumentor
 

diff --git a/docs/backends/datadog.mdx b/docs/backends/datadog.mdx
@@ -5,11 +5,16 @@ title: "Datadog"
 ## Obtaining an API Key
 
 On the left sidebar, click on your username and then click on **Organization Settings**
-![](/backends/images/datadog1.png)
+
+<Frame>
+    <img src="/backends/images/datadog1.png" alt="Organization settings menu" />
+</Frame>
 
 Click on **API Keys** and then click on **New Key** and give it a name.
 
-![](/backends/images/datadog2.png)
+<Frame>
+    <img src="/backends/images/datadog2.png" alt="New API key screen" />
+</Frame>
 
 ## Configuring the Datadog Backend
 

diff --git a/docs/backends/grafanacloud.mdx b/docs/backends/grafanacloud.mdx
@@ -5,12 +5,18 @@ title: "Grafana Cloud"
 Currently, Odigos supports Grafana Cloud as a three data source types: Prometheus, Loki, and Tempo.
 
 All the connection details can be found at [grafana.com](grafana.com) under **My Account**
-![](/backends/images/grafanacloud1.png)
+
+<Frame>
+    <img src="/backends/images/grafanacloud1.png" alt="Grafana labs website" />
+</Frame>
 
 ## Configuring Grafana Cloud managed Loki
 
 Press **Details** under the Loki data source
-![](/backends/images/grafanacloud2.png)
+
+<Frame>
+    <img src="/backends/images/grafanacloud2.png" alt="Loki logging service setup" />
+</Frame>
 
 Enter the following settings into Odigos UI:
 
@@ -21,7 +27,10 @@ Enter the following settings into Odigos UI:
 ## Configuring Grafana Cloud managed Prometheus
 
 Press **Details** under the Prometheus data source
-![](/backends/images/grafanacloud3.png)
+
+<Frame>
+    <img src="/backends/images/grafanacloud3.png" alt="Prometheus monitoring service setup" />
+</Frame>
 
 Insert into Odigos the following settings:
 
@@ -32,7 +41,10 @@ Insert into Odigos the following settings:
 ## Configuring Grafana Cloud managed Tempo
 
 Press **Details** under the Tempo data source
-![](/backends/images/grafanacloud4.png)
+
+<Frame>
+    <img src="/backends/images/grafanacloud4.png" alt="Tempo tracing service setup" />
+</Frame>
 
 Insert into Odigos the following settings:
 

diff --git a/docs/backends/honeycomb.mdx b/docs/backends/honeycomb.mdx
@@ -7,7 +7,10 @@ title: "Honeycomb"
 [Click here](https://ui.honeycomb.io/odigos/environments/test/api_keys) to go to Honeycomb API Keys page and click on **Create API Key**
 
 Make sure the API Key is permitted to **Send Events** to Honeycomb.
-![](/backends/images/honeycomb.png)
+
+<Frame>
+    <img src="/backends/images/honeycomb.png" alt="API Keys settings page in Honeycomb" />
+</Frame>
 
 ## Configuring Honeycomb Backend
 

diff --git a/docs/backends/newrelic.mdx b/docs/backends/newrelic.mdx
@@ -6,11 +6,15 @@ title: "New Relic"
 
 On the left sidebar, click on your account name and select **API Keys** and then click on **Create a key**.
 
-![](/backends/images/newrelic1.png)
+<Frame>
+    <img src="/backends/images/newrelic1.png" alt="New Relic API keys" />
+</Frame>
 
 For key type select **Ingest - License**, give a name to your key and press **Create a key**.
 
-![](/backends/images/newrelic2.png)
+<Frame>
+    <img src="/backends/images/newrelic2.png" alt="Create an API key screen in New Relic" />
+</Frame>
 
 ## Configuring New Relic Backend
 

diff --git a/docs/backends/splunk.mdx b/docs/backends/splunk.mdx
@@ -5,10 +5,16 @@ title: "Splunk"
 ## Obtaining Access Token
 
 Go to **Settings** then **Access Tokens**. and click **Create New Token**
-![](/backends/images/splunk1.png)
+
+<Frame>
+    <img src="/backends/images/splunk1.png" alt="Splunk Access Tokens menu" />
+</Frame>
 
 Give the token a name and select **Ingest Token** for the authorization scope and click create.
-![](/backends/images/splunk2.png)
+
+<Frame>
+    <img src="/backends/images/splunk2.png" alt="Create Access Token form in Splunk" />
+</Frame>
 
 ## Configuring the Splunk Backend
 

diff --git a/docs/instrumenting.mdx b/docs/instrumenting.mdx
@@ -8,7 +8,9 @@ sidebarTitle: "Generating Traces"
 
 You should now see the following page:
 
-![Select target applications](/images/choose_apps.png)
+<Frame>
+    <img src="/images/choose_apps.png" alt="Select target applications" />
+</Frame>
 
 Select all the applications in the `default` namespace and click `Next`.
 <Note>
@@ -20,7 +22,9 @@ Selecting **Apply for future apps** will automatically generate distributed trac
 In the next step, you will be asked to select a destination for your traces.
 Scroll down to the self hosted destinations and click on **Jaeger**.
 
-![Select Jaeger](/images/choose_jaeger.png)
+<Frame>
+    <img src="/images/choose_jaeger.png" alt="Select Jaeger" />
+</Frame>
 
 #### Connection details