From cf2a7687e0bc388532b5b183ff0bb5e497b1ed58 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 14 Feb 2025 10:26:29 +0000 Subject: [PATCH] Update `make docs` procedure (#100167) Co-authored-by: grafanabot Co-authored-by: Jack Baldry --- docs/docs.mk | 7 +++++++ docs/make-docs | 6 ++++++ 2 files changed, 13 insertions(+) diff --git a/docs/docs.mk b/docs/docs.mk index c0aae10ba50..68a00fcf6e0 100644 --- a/docs/docs.mk +++ b/docs/docs.mk @@ -120,3 +120,10 @@ update: ## Fetch the latest version of this Makefile and the `make-docs` script curl -s -LO https://raw.githubusercontent.com/grafana/writers-toolkit/main/docs/docs.mk curl -s -LO https://raw.githubusercontent.com/grafana/writers-toolkit/main/docs/make-docs chmod +x make-docs + +.PHONY: topic/% +topic/%: ## Create a topic from the Writers' Toolkit template. Specify the topic type as the target, for example, `make topic/task TOPIC_PATH=sources/my-new-topic.md`. +topic/%: + $(if $(TOPIC_PATH),,$(error "You must set the TOPIC_PATH variable to the path where the $(@F) topic will be created. For example: make $(@) TOPIC_PATH=sources/my-new-topic.md")) + mkdir -p $(dir $(TOPIC_PATH)) + curl -s -o $(TOPIC_PATH) https://raw.githubusercontent.com/grafana/writers-toolkit/refs/heads/main/docs/static/templates/$(@F)-template.md diff --git a/docs/make-docs b/docs/make-docs index e8111479d7c..a81ec7530f3 100755 --- a/docs/make-docs +++ b/docs/make-docs @@ -8,6 +8,12 @@ # [Semantic versioning](https://semver.org/) is used to help the reader identify the significance of changes. # Changes are relevant to this script and the support docs.mk GNU Make interface. # +# ## 8.5.0 (2025-02-13) +# +# ### Added +# +# - make topic/ TOPIC_PATH= target to create a new topic from the Writers' Toolkit templates. +# # ## 8.4.0 (2025-01-27) # # ### Fixed