VictoriaMetrics/docs/assets/README.md

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.
docs/assets: add README.md with the explanation on which files can be put into the docs/assets folder 2023-01-27 20:02:16 +01:00			`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.