Update make docs procedure (#4780)
Some checks failed
docker / get-tag (push) Waiting to run
docker / docker (tempo, map[arch:amd64 runner:ubuntu-24.04]) (push) Blocked by required conditions
docker / docker (tempo, map[arch:arm64 runner:github-hosted-ubuntu-arm64]) (push) Blocked by required conditions
docker / docker (tempo-cli, map[arch:amd64 runner:ubuntu-24.04]) (push) Blocked by required conditions
docker / docker (tempo-cli, map[arch:arm64 runner:github-hosted-ubuntu-arm64]) (push) Blocked by required conditions
docker / docker (tempo-query, map[arch:amd64 runner:ubuntu-24.04]) (push) Blocked by required conditions
docker / docker (tempo-query, map[arch:arm64 runner:github-hosted-ubuntu-arm64]) (push) Blocked by required conditions
docker / docker (tempo-vulture, map[arch:amd64 runner:ubuntu-24.04]) (push) Blocked by required conditions
docker / docker (tempo-vulture, map[arch:arm64 runner:github-hosted-ubuntu-arm64]) (push) Blocked by required conditions
docker / manifest (tempo) (push) Blocked by required conditions
docker / manifest (tempo-cli) (push) Blocked by required conditions
docker / manifest (tempo-query) (push) Blocked by required conditions
docker / manifest (tempo-vulture) (push) Blocked by required conditions
docker / cd-to-dev-env (push) Blocked by required conditions
Snyk Monitor Scanning / snyk-scan-ci (push) Waiting to run
Stale check / stale (push) Has been cancelled
Update `make docs` procedure / main (push) Has been cancelled

Co-authored-by: grafanabot <bot@grafana.com>
This commit is contained in:
github-actions[bot]
2025-03-03 13:02:43 +00:00
committed by GitHub
parent 09a4f2b3a7
commit db1d5ead76
2 changed files with 7 additions and 1 deletions

View File

@ -125,7 +125,7 @@ update: ## Fetch the latest version of this Makefile and the `make-docs` script
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/%:
$(patsubst %,topic/%,$(TOPIC_TYPES)):
$(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

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.2 (2025-02-28)
#
# ### Fixed
#
# - topic/<KIND> targets are no longer no-ops as a result of 8.5.1.
#
# ## 8.5.1 (2025-02-18)
#
# ### Fixed