Update make docs procedure (#100945)

Co-authored-by: grafanabot <bot@grafana.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
This commit is contained in:
github-actions[bot]
2025-02-19 09:54:01 +00:00
committed by GitHub
co-authored by grafanabot Jack Baldry
parent e93ff154df
commit cf624a6cf0
2 changed files with 9 additions and 1 deletions
+3 -1
View File
@@ -121,7 +121,9 @@ 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/make-docs
chmod +x make-docs
.PHONY: topic/%
# ls static/templates/ | sed 's/-template\.md//' | xargs
TOPIC_TYPES := concept multiple-tasks reference section task tutorial visualization
.PHONY: $(patsubst %,topic/%,$(TOPIC_TYPES))
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"))
+6
View File
@@ -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.1 (2025-02-18)
#
# ### Fixed
#
# - PHONY declaration for topic/<KIND> targets.
#
# ## 8.5.0 (2025-02-13)
#
# ### Added