VictoriaMetrics/docs/assets
2023-01-27 11:31:49 -08:00
..
css add option to add Copy button for code snippets () 2021-07-06 10:54:37 +03:00
images docs/managed-victoriametrics/user-management.md: move the associated images to docs/managed-victoriametrics/ folder with user-management_ prefix according to docs/assets/README.md 2023-01-27 11:31:49 -08:00
js add option to add Copy button for code snippets () 2021-07-06 10:54:37 +03:00
README.md 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 2023-01-27 11:31:49 -08: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. This also simplifies referring the associated images from docs displayed at various views: