Skip to content

Commit

Permalink
Update make docs procedure (#1870)
Browse files Browse the repository at this point in the history
Co-authored-by: grafanabot <bot@grafana.com>
  • Loading branch information
github-actions[bot] and grafanabot authored Feb 14, 2025
1 parent 1c66fe1 commit 218c8d5
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 2 deletions.
3 changes: 1 addition & 2 deletions docs/docs.mk
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,6 @@ update: ## Fetch the latest version of this Makefile and the `make-docs` script
.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 $(@) topic will be created.
For example: make $(@) TOPIC_PATH=sources/my-new-topic.md"))
$(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
6 changes: 6 additions & 0 deletions docs/make-docs
Original file line number Diff line number Diff line change
Expand Up @@ -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/<KIND> TOPIC_PATH=<PATH> target to create a new topic from the Writers' Toolkit templates.
#
# ## 8.4.0 (2025-01-27)
#
# ### Fixed
Expand Down

0 comments on commit 218c8d5

Please sign in to comment.