diff --git a/docs/README.md b/docs/README.md index f3c68b84ff..27cc0ba9b7 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2676,6 +2676,9 @@ used or posted in other docs, GitHub issues, stackoverlow answers, etc. Please, keep image size and number of images per single page low. Keep the docs page as lightweight as possible. +Image 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`. + If the page needs to have many images, consider using WEB-optimized image format [webp](https://developers.google.com/speed/webp). When adding a new doc with many images use `webp` format right away. Or use a Makefile command below to convert already existing images at `docs` folder automatically to `web` format: diff --git a/docs/Single-server-VictoriaMetrics.md b/docs/Single-server-VictoriaMetrics.md index fea905f49c..e2dcce2744 100644 --- a/docs/Single-server-VictoriaMetrics.md +++ b/docs/Single-server-VictoriaMetrics.md @@ -2684,6 +2684,9 @@ used or posted in other docs, GitHub issues, stackoverlow answers, etc. Please, keep image size and number of images per single page low. Keep the docs page as lightweight as possible. +Image 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`. + If the page needs to have many images, consider using WEB-optimized image format [webp](https://developers.google.com/speed/webp). When adding a new doc with many images use `webp` format right away. Or use a Makefile command below to convert already existing images at `docs` folder automatically to `web` format: