docs: Improve metrics reference title and frontmatter

Signed-off-by: Anna Kapuscinska <[email protected]>
cilium · Mar 1, 2024 · a2116e4 · a2116e4
1 parent 1683fca
commit a2116e4
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/Makefile b/Makefile
@@ -427,9 +427,10 @@ METRICS_DOCS_PATH := docs/content/en/docs/reference/metrics.md
 .PHONY: metrics-docs
 metrics-docs: tetra
 	echo '---' > $(METRICS_DOCS_PATH)
-	echo 'title: "Metrics Reference"' >> $(METRICS_DOCS_PATH)
+	echo 'title: "Metrics"' >> $(METRICS_DOCS_PATH)
 	echo 'description: >' >> $(METRICS_DOCS_PATH)
-	echo '  This reference documents Prometheus metrics exposed by Tetragon.' >> $(METRICS_DOCS_PATH)
+	echo '  This reference is autogenerated from the Tetragon Prometheus metrics registry' >> $(METRICS_DOCS_PATH)
+	echo '  using github.com/isovalent/metricstool' >> $(METRICS_DOCS_PATH)
 	echo 'weight: 4' >> $(METRICS_DOCS_PATH)
 	echo '---' >> $(METRICS_DOCS_PATH)
 	$(CONTAINER_ENGINE) run --rm -v $(PWD):$(PWD) -w $(PWD) $(GO_IMAGE) ./tetra metrics-docs health >> $(METRICS_DOCS_PATH)

diff --git a/docs/content/en/docs/reference/metrics.md b/docs/content/en/docs/reference/metrics.md