github-mirrors/VictoriaMetrics
1
0
Fork 0
mirror of https://github.com/VictoriaMetrics/VictoriaMetrics.git synced 2024-11-21 14:44:00 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs/assets/README.md: mention that locally placed doc-specific images simplify referring them from various views without the need to deal with folder prefixes

Browse source
This commit is contained in:
Aliaksandr Valialkin 2023-01-27 11:29:23 -08:00
parent 54a0ccbaca
commit 6342eb5523
No known key found for this signature in database
GPG key ID: A72BEC6CD3D0DED1
1 changed files with 5 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/assets/README.md
View file

@ -5,4 +5,8 @@ used in a particular doc. Such files must be placed in the same folder as the do
and they must have the same prefix as the doc filename. For example, all the images for docs/foo/bar.md
should have filenames starting from docs/foo/bar. This simplifies lifetime management for these files.
For example, if the corresponding doc is removed, then it is easy to remove all the associated
images with a simple `rm -rf docs/foo/bar*` command.
images with a simple `rm -rf docs/foo/bar*` command. This also simplifies referring the associated images
from docs displayed at various views:
- https://docs.victoriametrics.com
- https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/docs