Kiu/VictoriaMetrics
Kiu/VictoriaMetrics
1
0
Fork 0
mirror of https://github.com/VictoriaMetrics/VictoriaMetrics.git synced 2024-12-15 08:23:34 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

docs/assets: add README.md with the explanation on which files can be put into the docs/assets folder

Browse Source
This commit is contained in:
Aliaksandr Valialkin 2023-01-27 11:02:16 -08:00
parent c06ec450ee
commit b024981bed
No known key found for this signature in database
GPG Key ID: A72BEC6CD3D0DED1
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/assets/README.md Normal file
View File

@ -0,0 +1,8 @@
This folder must contain only files, which are needed for generating https://docs.victoriametrics.com .
This folder **should not contain** files specific for a particular documentation pages such as images
used in a particular doc. Such files must be placed in the same folder as the doc itself
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.