Skip to content

Commit 5d1b5b7

Browse files
Update syntax image examples to use images path (#1162)
* 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. * Update image locations * fix build errors and hints --------- Co-authored-by: Colleen McGinnis <[email protected]>
1 parent a32602f commit 5d1b5b7

15 files changed

+33
-36
lines changed

docs/development/index.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,3 @@ navigation_title: Development
55
# Development Guide
66

77
TODO write development documentation here
8-
9-
10-
![Image outside of scope](../images/great-drawing-of-new-structure.png)

docs/syntax/applies.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -67,24 +67,24 @@ Both are equivalent, note `all` just means we won't be rendering the version por
6767

6868
## Structured model
6969

70-
![Applies To Model](img/applies.png)
70+
![Applies To Model](images/applies.png)
7171

7272
The above model is projected to the following structured yaml.
7373

7474
```yaml
7575
---
7676
applies_to:
77-
stack:
77+
stack:
7878
deployment:
79-
eck:
80-
ess:
81-
ece:
82-
self:
79+
eck:
80+
ess:
81+
ece:
82+
self:
8383
serverless:
84-
security:
85-
elasticsearch:
86-
observability:
87-
product:
84+
security:
85+
elasticsearch:
86+
observability:
87+
product:
8888
---
8989
```
9090
This allows you to annotate various facets as defined in [](../migration/versioning.md)
@@ -128,7 +128,7 @@ serverless:
128128
product: coming 9.5, discontinued 9.7
129129
```
130130

131-
A header may be followed by an `{applies_to}` directive which will contextualize the applicability
131+
A header may be followed by an `{applies_to}` directive which will contextualize the applicability
132132
of the section further.
133133

134134
:::{note}
@@ -154,7 +154,7 @@ stack: ga 9.1
154154

155155
This will allow the yaml inside the `{applies-to}` directive to be fully highlighted.
156156

157-
## Inline Applies To
157+
## Inline Applies To
158158

159159
Inline applies to can be placed anywhere using the following syntax
160160

docs/syntax/images.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -9,21 +9,21 @@ Images can be referenced from the top-level `_static` dir or a local image dir.
99
## Block-level images
1010

1111
```markdown
12-
![APM](img/apm.png)
12+
![APM](images/apm.png)
1313
```
1414

15-
![APM](img/apm.png)
15+
![APM](images/apm.png)
1616

1717
Or, use the `image` directive.
1818

1919
```markdown
20-
:::{image} img/observability.png
20+
:::{image} images/observability.png
2121
:alt: Elasticsearch
2222
:width: 250px
2323
:::
2424
```
2525

26-
:::{image} img/observability.png
26+
:::{image} images/observability.png
2727
:alt: Elasticsearch
2828
:width: 250px
2929
:::
@@ -33,36 +33,36 @@ Or, use the `image` directive.
3333
Screenshots are images displayed with a box-shadow. Define a screenshot by adding the `:screenshot:` attribute to a block-level image directive.
3434

3535
```markdown
36-
:::{image} img/apm.png
36+
:::{image} images/apm.png
3737
:screenshot:
3838
:::
3939
```
4040

41-
:::{image} img/apm.png
41+
:::{image} images/apm.png
4242
:screenshot:
4343
:::
4444

4545
## Inline images
4646

4747
```markdown
48-
Here is the same image used inline ![Elasticsearch](img/observability.png "elasticsearch =50%x50%")
48+
Here is the same image used inline ![Elasticsearch](images/observability.png "elasticsearch =50%x50%")
4949
```
5050

51-
Here is the same image used inline ![Elasticsearch](img/observability.png "elasticsearch =50%x50%")
51+
Here is the same image used inline ![Elasticsearch](images/observability.png "elasticsearch =50%x50%")
5252

5353

5454
### Inline image titles
5555

5656
Titles are optional making this the minimal syntax required
5757

5858
```markdown
59-
![Elasticsearch](img/observability.png)
59+
![Elasticsearch](images/observability.png)
6060
```
6161

6262
Including a title can be done by supplying it as an optional argument.
6363

6464
```markdown
65-
![Elasticsearch](img/observability.png "elasticsearch")
65+
![Elasticsearch](images/observability.png "elasticsearch")
6666
```
6767

6868
### Inline image sizing
@@ -92,16 +92,16 @@ If `H` is omitted `W` is used as the height as well.
9292
### SVG
9393

9494
```markdown
95-
![Elasticsearch](img/alerts.svg)
95+
![Elasticsearch](images/alerts.svg)
9696
```
97-
![Elasticsearch](img/alerts.svg)
97+
![Elasticsearch](images/alerts.svg)
9898

9999
### GIF
100100

101101
```markdown
102-
![Elasticsearch](img/timeslider.gif)
102+
![Elasticsearch](images/timeslider.gif)
103103
```
104-
![Elasticsearch](img/timeslider.gif)
104+
![Elasticsearch](images/timeslider.gif)
105105

106106

107107
## Asciidoc syntax
@@ -113,4 +113,4 @@ image::images/metrics-alert-filters-and-group.png[Metric threshold filter and gr
113113

114114
```asciidoc
115115
image::images/synthetics-get-started-projects.png[]
116-
```
116+
```
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)