From a2116e4c0ed3b3e01be32308b696c9f6032e7215 Mon Sep 17 00:00:00 2001 From: Anna Kapuscinska Date: Thu, 29 Feb 2024 23:16:20 +0000 Subject: [PATCH] docs: Improve metrics reference title and frontmatter Signed-off-by: Anna Kapuscinska --- Makefile | 5 +++-- docs/content/en/docs/reference/metrics.md | 5 +++-- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/Makefile b/Makefile index 4d645901fa3..c876c148911 100644 --- 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 index 0c9b93abc9a..916ce8ccbd0 100644 --- a/docs/content/en/docs/reference/metrics.md +++ b/docs/content/en/docs/reference/metrics.md @@ -1,7 +1,8 @@ --- -title: "Metrics Reference" +title: "Metrics" description: > - This reference documents Prometheus metrics exposed by Tetragon. + This reference is autogenerated from the Tetragon Prometheus metrics registry + using github.com/isovalent/metricstool weight: 4 --- ## Tetragon Health Metrics