apitech
/
grafana
mirror of https://github.com/grafana/grafana
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update `make docs` procedure (#101497)

Browse Source 
Co-authored-by: grafanabot <bot@grafana.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
fix-vendoring-issues
github-actions[bot] 5 months ago committed by GitHub
parent 5ef3400115
commit 56b030492f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 7 additions and 1 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 2
      docs/docs.mk
  2. 6
      docs/make-docs

2
docs/docs.mk
Unescape 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 TOPIC_TYPES := concept multiple-tasks reference section task tutorial visualization
.PHONY: $(patsubst %,topic/%,$(TOPIC_TYPES)) .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/%: ## 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")) $(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)) 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 curl -s -o $(TOPIC_PATH) https://raw.githubusercontent.com/grafana/writers-toolkit/refs/heads/main/docs/static/templates/$(@F)-template.md

6
docs/make-docs
Unescape View File

@ -8,6 +8,12 @@
# [Semantic versioning](https://semver.org/) is used to help the reader identify the significance of changes. # [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. # 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) # ## 8.5.1 (2025-02-18)
# #
# ### Fixed # ### Fixed

Write Preview
Loading…
Cancel
Save