From b024981bedabb452a5e7f9b198a33a2431b656c2 Mon Sep 17 00:00:00 2001 From: Aliaksandr Valialkin Date: Fri, 27 Jan 2023 11:02:16 -0800 Subject: [PATCH] docs/assets: add README.md with the explanation on which files can be put into the docs/assets folder --- docs/assets/README.md | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 docs/assets/README.md diff --git a/docs/assets/README.md b/docs/assets/README.md new file mode 100644 index 0000000000..85d1677650 --- /dev/null +++ b/docs/assets/README.md @@ -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.