github-mirrors/VictoriaMetrics
1
0
Fork 0
mirror of https://github.com/VictoriaMetrics/VictoriaMetrics.git synced 2024-11-21 14:44:00 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs/Makefile: simplify and document make docs-debug after ce4cc4cbb2

Browse source 
- 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
This commit is contained in:
Aliaksandr Valialkin 2024-07-25 13:12:01 +02:00
parent 8cb1822b94
commit 423e35c7b7
No known key found for this signature in database
GPG key ID: 52C003EE2BCDB9EB
2 changed files with 15 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -2641,7 +2641,9 @@ Report bugs and propose new features [here](https://github.com/VictoriaMetrics/V
VictoriaMetrics documentation is available at [https://docs.victoriametrics.com/](https://docs.victoriametrics.com/). VictoriaMetrics documentation is available at [https://docs.victoriametrics.com/](https://docs.victoriametrics.com/).
It is built from `*.md` files located in [docs](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/docs) folder It is built from `*.md` files located in [docs](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/docs) folder
and gets automatically updated once changes are merged to [master](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master) branch. and gets automatically updated once changes are merged to [master](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master) branch.
To update the documentation follow the steps below: To update the documentation follow the steps below:
- [Fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks) - [Fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)
VictoriaMetrics repo and apply changes to the docs: VictoriaMetrics repo and apply changes to the docs:
- To update [the main page](https://docs.victoriametrics.com/) modify [this file](https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/README.md). - To update [the main page](https://docs.victoriametrics.com/) modify [this file](https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/README.md).
@ -2653,10 +2655,13 @@ To update the documentation follow the steps below:
make docs-sync make docs-sync
``` ```
- Verify the changes locally by running `make docs-debug`. This command starts locally available docs server at `http://localhost:1313`.
Press `Ctrl+C` in the console window were the `make docs-debug` command runs after verifying the changes in docs at `http://localhost:1313`.
- Create [a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) - Create [a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)
with proposed changes and wait for it to be merged. with proposed changes and wait for it to be merged.
Requirements for changes to docs: ### Requirements for changes in docs
- Keep backward compatibility of existing links. Avoid changing anchors or deleting pages as they could have been - Keep backward compatibility of existing links. Avoid changing anchors or deleting pages as they could have been
used or posted in other docs, GitHub issues, stackoverlow answers, etc. used or posted in other docs, GitHub issues, stackoverlow answers, etc.

23
docs/Makefile
View file

@ -1,7 +1,3 @@
ROOTDIR := $(dir $(realpath $(lastword $(MAKEFILE_LIST))))
REPODIR := $(ROOTDIR)/..
WORKDIR := $(REPODIR)/..
# These commands must be run from the VictoriaMetrics repository root # These commands must be run from the VictoriaMetrics repository root
# Converts images at docs folder to webp format # Converts images at docs folder to webp format
@ -20,19 +16,18 @@ docs-images-to-webp-by-extension:
find docs/ -type f ! -path 'docs/operator/*' ! -path 'docs/_site/*' -name '*.$(IMAGES_EXTENSION)' -print0 | xargs -0 rm -f find docs/ -type f ! -path 'docs/operator/*' ! -path 'docs/_site/*' -name '*.$(IMAGES_EXTENSION)' -print0 | xargs -0 rm -f
docs-debug: docs-debug:
if [ ! -d $(WORKDIR)/vmdocs ]; then \ if [ ! -d vmdocs ]; then \
git clone git@github.com:VictoriaMetrics/vmdocs $(WORKDIR)/vmdocs; \ git clone --depth 1 git@github.com:VictoriaMetrics/vmdocs vmdocs; \
fi; \ fi; \
cd $(WORKDIR)/vmdocs && \ cd vmdocs && \
git checkout main && \ git checkout main && \
git pull origin main && \ git pull origin main && \
cd $(REPODIR) && \ cd .. && \
docker build \ docker build \
-t vmdocs \ -t vmdocs-docker-package \
$(WORKDIR)/vmdocs && \ vmdocs && \
docker rm -f vmdocs || true && \
docker run \ docker run \
-d \ --rm \
--name vmdocs \ --name vmdocs-docker-container \
-p 1313:1313 \ -p 1313:1313 \
-v ./docs:/opt/docs/content vmdocs -v ./docs:/opt/docs/content vmdocs-docker-package