Update images.md #1090
Open
Update images.md #1090
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Relates to elastic/docs-content#1079
55 tasks
Mpdreamz
requested changes
Apr 11, 2025
docs/syntax/images.md
Outdated
|
|
||
| Images can be referenced from the top-level `_static` dir or a local image dir. | ||
| :::{note} | ||
| If you reference an image using a relative path, it must be relative to the `toc.yml` or `docset.yml` rather than relative to the page that uses it. |
There was a problem hiding this comment.
It can be a relative path but it can not go relative beyond the toc.
e.g
/images/
- other.png
/solutions/
/images/
- observability-apm-app-landing.png`
/page/
- index.md
toc.yml
../images/observability-apm-app-landing.png from index.md is fine because that lives in the same subtree as the toc.yml the page lives in.
../../images/other.png lives outside the toc.yml subtree so is at risk of being broken if the assembler rehomes this subtree.
`
There was a problem hiding this comment.
Thanks, i've taken another go at the explanation since i think this might confuse folks
lcawl
commented
Apr 11, 2025
lcawl
commented
Apr 11, 2025
lcawl
commented
Apr 11, 2025
lcawl
commented
Apr 11, 2025
lcawl
commented
Apr 12, 2025
lcawl
commented
Apr 12, 2025
lcawl
commented
Apr 12, 2025
lcawl
commented
Apr 12, 2025
lcawl
commented
Apr 14, 2025
lcawl
commented
Apr 14, 2025
|
|
||
| Images can be referenced from the top-level `_static` dir or a local image dir. | ||
| If a page uses an image that exists outside the folder that contains the `toc.yml` file or `docset.yml` file that contains that page, the image will fail to render and will generate warnings. Likewise, if a snippet in a [file inclusion](/syntax/file_inclusion.md) includes an image and is used in pages that exist in different `toc.yml`, the images will break. |
There was a problem hiding this comment.
and is used in pages that exist in different
toc.yml, the images will break...
Unless the images is copied into all the folders where the re-use occurs in exactly the same relative folder structure?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Relates to elastic/docs-content#1079
The image guidelines seem to imply that we can use relative image paths but they seem problematic when you go from a local build to a fully assembled build. This PR therefore recommends using absolute paths.