Skip to content

Commit fccc98d

Browse files
authored
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.
1 parent 0f77059 commit fccc98d

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

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+
```

0 commit comments

Comments
 (0)