mirror of
https://github.com/VictoriaMetrics/VictoriaMetrics.git
synced 2024-12-24 03:06:48 +01:00
f320efd5ad
- Document `make docs-debug` command at https://docs.victoriametrics.com/#documentation - Remove unneeded ROOTDIR, REPODIR and WORKDIR env vars from docs/Makefile , since it is documented and expected that all the Makefile commands are run from the repository root. - Use `docker --rm` for running Docker container with local docs server, so it is automatically removed after pressing `Ctrl+C`. This makes the container cleanup automatic. Updates https://github.com/VictoriaMetrics/VictoriaMetrics/pull/6677
34 lines
1.2 KiB
Makefile
34 lines
1.2 KiB
Makefile
# These commands must be run from the VictoriaMetrics repository root
|
|
|
|
# Converts images at docs folder to webp format
|
|
# See https://docs.victoriametrics.com/single-server-victoriametrics/#images-in-documentation
|
|
docs-images-to-webp:
|
|
IMAGES_EXTENSION=jpg $(MAKE) docs-images-to-webp-by-extension
|
|
IMAGES_EXTENSION=jpeg $(MAKE) docs-images-to-webp-by-extension
|
|
IMAGES_EXTENSION=png $(MAKE) docs-images-to-webp-by-extension
|
|
|
|
docs-images-to-webp-by-extension:
|
|
docker run --rm -it \
|
|
-v $(shell pwd)/docs:/docs \
|
|
elswork/cwebp \
|
|
sh -c 'find /docs/ -type f ! -path "/docs/operator/*" ! -path "/docs/_site/*" -name "*.$(IMAGES_EXTENSION)" -print0 | \
|
|
xargs -0 -P $(MAKE_CONCURRENCY) -I {} sh -c '"'"'cwebp -preset drawing -m 6 -o "$${1%.*}.webp" $$1'"'"' _ {}'
|
|
find docs/ -type f ! -path 'docs/operator/*' ! -path 'docs/_site/*' -name '*.$(IMAGES_EXTENSION)' -print0 | xargs -0 rm -f
|
|
|
|
docs-debug:
|
|
if [ ! -d vmdocs ]; then \
|
|
git clone --depth 1 git@github.com:VictoriaMetrics/vmdocs vmdocs; \
|
|
fi; \
|
|
cd vmdocs && \
|
|
git checkout main && \
|
|
git pull origin main && \
|
|
cd .. && \
|
|
docker build \
|
|
-t vmdocs-docker-package \
|
|
vmdocs && \
|
|
docker run \
|
|
--rm \
|
|
--name vmdocs-docker-container \
|
|
-p 1313:1313 \
|
|
-v ./docs:/opt/docs/content vmdocs-docker-package
|