mirror of
https://github.com/VictoriaMetrics/VictoriaMetrics.git
synced 2024-11-21 14:44:00 +00:00
c077a6e0f3
### Describe Your Changes
added make target, which updates `{{% available_from "#" %}}` shortcode
to `{{% available_from "$(PKG_TAG)" %}}` if PKG_TAG matches expression
`v.*`. `{{% available_from %}}` shortcode was introduced in
https://github.com/VictoriaMetrics/vmdocs/pull/89 to show a reference to
a version in a changelog since which a feature was introduced
related issue
https://github.com/VictoriaMetrics/VictoriaMetrics/issues/7376
### Checklist
The following checks are **mandatory**:
- [ ] My change adheres [VictoriaMetrics contributing
guidelines](https://docs.victoriametrics.com/contributing/).
(cherry picked from commit 30dd4cdc0d)
44 lines
1.3 KiB
Makefile
44 lines
1.3 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-image:
|
|
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
|
|
|
|
docs-debug: docs docs-image
|
|
docker run \
|
|
--rm \
|
|
--name vmdocs-docker-container \
|
|
-p 1313:1313 \
|
|
-v ./docs:/opt/docs/content vmdocs-docker-package
|
|
|
|
docs-update-version: docs-image
|
|
$(if $(filter v%,$(PKG_TAG)), \
|
|
docker run \
|
|
--rm \
|
|
--entrypoint /usr/bin/find \
|
|
--name vmdocs-docker-container \
|
|
-v ./docs:/opt/docs/content vmdocs-docker-package \
|
|
content \
|
|
-regex ".*\.md" \
|
|
-exec sed -i 's/{{% available_from "#" %}}/{{% available_from "$(PKG_TAG)" %}}/g' {} \;, \
|
|
$(info "Skipping docs version update, invalid $$PKG_TAG: $(PKG_TAG)"))
|
|
|
|
docs-images-to-webp: docs-image
|
|
docker run \
|
|
--rm \
|
|
--entrypoint /usr/bin/find \
|
|
--name vmdocs-docker-container \
|
|
-v ./docs:/opt/docs/content vmdocs-docker-package \
|
|
content \
|
|
-regex ".*\.\(png\|jpg\|jpeg\)" \
|
|
-exec sh -c 'cwebp -preset drawing -m 6 -o $$(echo {} | cut -f-1 -d.).webp {} && rm -rf {}' {} \;
|