From 96d6f7b99cb80394a99a84dd6e29df4a209195bb Mon Sep 17 00:00:00 2001 From: Anna Kapuscinska Date: Fri, 1 Mar 2024 16:04:41 +0000 Subject: [PATCH] docs: Document how metrics reference is generated with a Hugo shortcode comment Signed-off-by: Anna Kapuscinska --- Makefile | 3 +++ docs/content/en/docs/reference/metrics.md | 3 +++ 2 files changed, 6 insertions(+) diff --git a/Makefile b/Makefile index c876c148911..eaa6ada6d23 100644 --- a/Makefile +++ b/Makefile @@ -433,6 +433,9 @@ metrics-docs: tetra echo ' using github.com/isovalent/metricstool' >> $(METRICS_DOCS_PATH) echo 'weight: 4' >> $(METRICS_DOCS_PATH) echo '---' >> $(METRICS_DOCS_PATH) + echo '{{< comment >}}' >> $(METRICS_DOCS_PATH) + echo 'This page is autogenerated via `make metrics-doc` please do not edit directly.' >> $(METRICS_DOCS_PATH) + echo '{{< /comment >}}' >> $(METRICS_DOCS_PATH) $(CONTAINER_ENGINE) run --rm -v $(PWD):$(PWD) -w $(PWD) $(GO_IMAGE) ./tetra metrics-docs health >> $(METRICS_DOCS_PATH) $(CONTAINER_ENGINE) run --rm -v $(PWD):$(PWD) -w $(PWD) $(GO_IMAGE) ./tetra metrics-docs resources >> $(METRICS_DOCS_PATH) $(CONTAINER_ENGINE) run --rm -v $(PWD):$(PWD) -w $(PWD) $(GO_IMAGE) ./tetra metrics-docs events >> $(METRICS_DOCS_PATH) diff --git a/docs/content/en/docs/reference/metrics.md b/docs/content/en/docs/reference/metrics.md index 916ce8ccbd0..a40dca322a7 100644 --- a/docs/content/en/docs/reference/metrics.md +++ b/docs/content/en/docs/reference/metrics.md @@ -5,6 +5,9 @@ description: > using github.com/isovalent/metricstool weight: 4 --- +{{< comment >}} +This page is autogenerated via `make metrics-doc` please do not edit directly. +{{< /comment >}} ## Tetragon Health Metrics ### `tetragon_build_info`