From 6342eb552365bf0ba5681dd52a7f0589a4c9b5df Mon Sep 17 00:00:00 2001 From: Aliaksandr Valialkin Date: Fri, 27 Jan 2023 11:29:23 -0800 Subject: [PATCH] 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 --- docs/assets/README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/assets/README.md b/docs/assets/README.md index 85d167765..93e9b55ba 100644 --- a/docs/assets/README.md +++ b/docs/assets/README.md @@ -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