Kiu/VictoriaMetrics
Kiu/VictoriaMetrics
1
0
Fork 0
mirror of https://github.com/VictoriaMetrics/VictoriaMetrics.git synced 2024-11-23 12:31:07 +01:00
Code Issues Actions 8 Packages Projects Releases Wiki Activity

docs: mention assets naming policy and placement

Browse Source 
Signed-off-by: hagen1778 <roman@victoriametrics.com>
This commit is contained in:
hagen1778 2024-07-12 11:12:24 +02:00
parent 2f65956259
commit f2c1d30011
No known key found for this signature in database
GPG Key ID: 3BF75F3741CA9640
3 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -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. 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). 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 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: convert already existing images at `docs` folder automatically to `web` format:

3
docs/README.md
View File

@ -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. 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). 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 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: convert already existing images at `docs` folder automatically to `web` format:

3
docs/Single-server-VictoriaMetrics.md
View File

@ -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. 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). 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 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: convert already existing images at `docs` folder automatically to `web` format: