docs: Document how metrics reference is generated with a Hugo shortco…

…de comment Signed-off-by: Anna Kapuscinska <[email protected]>
cilium · Mar 1, 2024 · 0004b79 · 0004b79
1 parent a2116e4
commit 0004b79
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git 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