From fccc98d80d91cfcc2499097c977fe14ce5efc79b Mon Sep 17 00:00:00 2001 From: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com> Date: Mon, 21 Apr 2025 14:51:32 -0400 Subject: [PATCH 1/3] Update docs to use `images` path As a convention our images are stored in a `images` directories, but our syntax instructions use `img` in the example image paths. This caused confusion for one developer so far, so I think it's worth updating our guide. --- docs/syntax/images.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/syntax/images.md b/docs/syntax/images.md index 6a9346592..75bf14ba3 100644 --- a/docs/syntax/images.md +++ b/docs/syntax/images.md @@ -9,21 +9,21 @@ Images can be referenced from the top-level `_static` dir or a local image dir. ## Block-level images ```markdown -![APM](img/apm.png) +![APM](images/apm.png) ``` -![APM](img/apm.png) +![APM](images/apm.png) Or, use the `image` directive. ```markdown -:::{image} img/observability.png +:::{image} images/observability.png :alt: Elasticsearch :width: 250px ::: ``` -:::{image} img/observability.png +:::{image} images/observability.png :alt: Elasticsearch :width: 250px ::: @@ -33,22 +33,22 @@ Or, use the `image` directive. Screenshots are images displayed with a box-shadow. Define a screenshot by adding the `:screenshot:` attribute to a block-level image directive. ```markdown -:::{image} img/apm.png +:::{image} images/apm.png :screenshot: ::: ``` -:::{image} img/apm.png +:::{image} images/apm.png :screenshot: ::: ## Inline images ```markdown -Here is the same image used inline ![Elasticsearch](img/observability.png "elasticsearch =50%x50%") +Here is the same image used inline ![Elasticsearch](images/observability.png "elasticsearch =50%x50%") ``` -Here is the same image used inline ![Elasticsearch](img/observability.png "elasticsearch =50%x50%") +Here is the same image used inline ![Elasticsearch](images/observability.png "elasticsearch =50%x50%") ### Inline image titles @@ -56,13 +56,13 @@ Here is the same image used inline ![Elasticsearch](img/observability.png "elast Titles are optional making this the minimal syntax required ```markdown -![Elasticsearch](img/observability.png) +![Elasticsearch](images/observability.png) ``` Including a title can be done by supplying it as an optional argument. ```markdown -![Elasticsearch](img/observability.png "elasticsearch") +![Elasticsearch](images/observability.png "elasticsearch") ``` ### Inline image sizing @@ -92,16 +92,16 @@ If `H` is omitted `W` is used as the height as well. ### SVG ```markdown -![Elasticsearch](img/alerts.svg) +![Elasticsearch](images/alerts.svg) ``` -![Elasticsearch](img/alerts.svg) +![Elasticsearch](images/alerts.svg) ### GIF ```markdown -![Elasticsearch](img/timeslider.gif) +![Elasticsearch](images/timeslider.gif) ``` -![Elasticsearch](img/timeslider.gif) +![Elasticsearch](images/timeslider.gif) ## Asciidoc syntax @@ -113,4 +113,4 @@ image::images/metrics-alert-filters-and-group.png[Metric threshold filter and gr ```asciidoc image::images/synthetics-get-started-projects.png[] -``` \ No newline at end of file +``` From 4d81fdf10297480220e5020598e6704d4c35ba61 Mon Sep 17 00:00:00 2001 From: David Kilfoyle Date: Mon, 28 Apr 2025 17:03:33 -0400 Subject: [PATCH 2/3] Update image locations --- docs/syntax/{img => images}/alerts.svg | 0 docs/syntax/{img => images}/annotations.png | Bin docs/syntax/{img => images}/apm.png | Bin docs/syntax/{img => images}/applies.png | Bin docs/syntax/{img => images}/bear.png | Bin docs/syntax/{img => images}/headings.png | Bin docs/syntax/{img => images}/nav-title.png | Bin docs/syntax/{img => images}/observability.png | Bin .../{img => images}/serverless-capabilities.svg | 0 docs/syntax/{img => images}/timeslider.gif | Bin docs/syntax/lists.md | 4 ++-- docs/syntax/quick-ref.md | 8 ++++---- 12 files changed, 6 insertions(+), 6 deletions(-) rename docs/syntax/{img => images}/alerts.svg (100%) rename docs/syntax/{img => images}/annotations.png (100%) rename docs/syntax/{img => images}/apm.png (100%) rename docs/syntax/{img => images}/applies.png (100%) rename docs/syntax/{img => images}/bear.png (100%) rename docs/syntax/{img => images}/headings.png (100%) rename docs/syntax/{img => images}/nav-title.png (100%) rename docs/syntax/{img => images}/observability.png (100%) rename docs/syntax/{img => images}/serverless-capabilities.svg (100%) rename docs/syntax/{img => images}/timeslider.gif (100%) diff --git a/docs/syntax/img/alerts.svg b/docs/syntax/images/alerts.svg similarity index 100% rename from docs/syntax/img/alerts.svg rename to docs/syntax/images/alerts.svg diff --git a/docs/syntax/img/annotations.png b/docs/syntax/images/annotations.png similarity index 100% rename from docs/syntax/img/annotations.png rename to docs/syntax/images/annotations.png diff --git a/docs/syntax/img/apm.png b/docs/syntax/images/apm.png similarity index 100% rename from docs/syntax/img/apm.png rename to docs/syntax/images/apm.png diff --git a/docs/syntax/img/applies.png b/docs/syntax/images/applies.png similarity index 100% rename from docs/syntax/img/applies.png rename to docs/syntax/images/applies.png diff --git a/docs/syntax/img/bear.png b/docs/syntax/images/bear.png similarity index 100% rename from docs/syntax/img/bear.png rename to docs/syntax/images/bear.png diff --git a/docs/syntax/img/headings.png b/docs/syntax/images/headings.png similarity index 100% rename from docs/syntax/img/headings.png rename to docs/syntax/images/headings.png diff --git a/docs/syntax/img/nav-title.png b/docs/syntax/images/nav-title.png similarity index 100% rename from docs/syntax/img/nav-title.png rename to docs/syntax/images/nav-title.png diff --git a/docs/syntax/img/observability.png b/docs/syntax/images/observability.png similarity index 100% rename from docs/syntax/img/observability.png rename to docs/syntax/images/observability.png diff --git a/docs/syntax/img/serverless-capabilities.svg b/docs/syntax/images/serverless-capabilities.svg similarity index 100% rename from docs/syntax/img/serverless-capabilities.svg rename to docs/syntax/images/serverless-capabilities.svg diff --git a/docs/syntax/img/timeslider.gif b/docs/syntax/images/timeslider.gif similarity index 100% rename from docs/syntax/img/timeslider.gif rename to docs/syntax/images/timeslider.gif diff --git a/docs/syntax/lists.md b/docs/syntax/lists.md index 0b9633e2d..85331edd8 100644 --- a/docs/syntax/lists.md +++ b/docs/syntax/lists.md @@ -205,7 +205,7 @@ To include a paragraph of text within a list item, indent the content by four sp 3. This is a list item with an image: - ![Image](./img/apm.png) + ![Image](./images/apm.png) 4. This is a list item with an admonition: @@ -229,7 +229,7 @@ To include a paragraph of text within a list item, indent the content by four sp 3. This is a list item with an image: - ![Image](./img/apm.png) + ![Image](./images/apm.png) 4. This is a list item with an admonition: diff --git a/docs/syntax/quick-ref.md b/docs/syntax/quick-ref.md index 152fe39c5..c7d280db7 100644 --- a/docs/syntax/quick-ref.md +++ b/docs/syntax/quick-ref.md @@ -353,7 +353,7 @@ Title of a page or a section. To create a heading, add number signs `#` at the b ::: ::::{dropdown} Output -:::{image} img/headings.png +:::{image} images/headings.png :screenshot: :alt: Heading levels :width: 300px @@ -381,12 +381,12 @@ Standard Markdown images: `[alt text]` in square brackets, followed by the image :::{dropdown} Syntax ```markdown -![Bear emerging from hibernation](img/bear.png) +![Bear emerging from hibernation](images/bear.png) ``` ::: :::{dropdown} Output -![Bear emerging from hibernation](img/bear.png) +![Bear emerging from hibernation](images/bear.png) ::: **DOs**
@@ -513,7 +513,7 @@ Page title (Markdown H1): :::{dropdown} Output -![Rendered nav title](img/nav-title.png) +![Rendered nav title](images/nav-title.png) ::: From e2e8264971e86b1dadeff8d85dd0bfce6e491269 Mon Sep 17 00:00:00 2001 From: Colleen McGinnis Date: Mon, 28 Apr 2025 17:03:29 -0500 Subject: [PATCH 3/3] fix build errors and hints --- docs/development/index.md | 3 --- docs/syntax/applies.md | 24 ++++++++++++------------ 2 files changed, 12 insertions(+), 15 deletions(-) diff --git a/docs/development/index.md b/docs/development/index.md index dd45ba7a3..efb778ecc 100644 --- a/docs/development/index.md +++ b/docs/development/index.md @@ -5,6 +5,3 @@ navigation_title: Development # Development Guide TODO write development documentation here - - -![Image outside of scope](../images/great-drawing-of-new-structure.png) \ No newline at end of file diff --git a/docs/syntax/applies.md b/docs/syntax/applies.md index a4f57cc8a..adc576492 100644 --- a/docs/syntax/applies.md +++ b/docs/syntax/applies.md @@ -67,24 +67,24 @@ Both are equivalent, note `all` just means we won't be rendering the version por ## Structured model -![Applies To Model](img/applies.png) +![Applies To Model](images/applies.png) The above model is projected to the following structured yaml. ```yaml --- applies_to: - stack: + stack: deployment: - eck: - ess: - ece: - self: + eck: + ess: + ece: + self: serverless: - security: - elasticsearch: - observability: - product: + security: + elasticsearch: + observability: + product: --- ``` This allows you to annotate various facets as defined in [](../migration/versioning.md) @@ -128,7 +128,7 @@ serverless: product: coming 9.5, discontinued 9.7 ``` -A header may be followed by an `{applies_to}` directive which will contextualize the applicability +A header may be followed by an `{applies_to}` directive which will contextualize the applicability of the section further. :::{note} @@ -154,7 +154,7 @@ stack: ga 9.1 This will allow the yaml inside the `{applies-to}` directive to be fully highlighted. -## Inline Applies To +## Inline Applies To Inline applies to can be placed anywhere using the following syntax