From f2c1d300113764aeaaddbfe3962d050055b8862e Mon Sep 17 00:00:00 2001 From: hagen1778 Date: Fri, 12 Jul 2024 11:12:24 +0200 Subject: [PATCH] docs: mention assets naming policy and placement Signed-off-by: hagen1778 --- README.md | 3 +++ docs/README.md | 3 +++ docs/Single-server-VictoriaMetrics.md | 3 +++ 3 files changed, 9 insertions(+) diff --git a/README.md b/README.md index 7fba15727..95e7f7d58 100644 --- a/README.md +++ b/README.md @@ -2673,6 +2673,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/README.md b/docs/README.md index f3c68b84f..27cc0ba9b 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 fea905f49..e2dcce274 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: