Skip to content

Commit 549fd17

Browse files
Update make docs procedure (#3873)
Co-authored-by: grafanabot <[email protected]>
1 parent ab724f3 commit 549fd17

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

docs/make-docs

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,19 @@
11
#!/bin/sh
2+
# shellcheck disable=SC2034
3+
#
24
# The source of this file is https://raw.githubusercontent.com/grafana/writers-toolkit/main/docs/make-docs.
35
# # `make-docs` procedure changelog
46
#
57
# Updates should conform to the guidelines in https://keepachangelog.com/en/1.1.0/.
68
# [Semantic versioning](https://semver.org/) is used to help the reader identify the significance of changes.
79
# Changes are relevant to this script and the support docs.mk GNU Make interface.
810
#
11+
# ## 8.4.0 (2025-01-27)
12+
#
13+
# ### Fixed
14+
#
15+
# - Correct mount for the /docs/grafana-cloud/send-data/fleet-management/ project.
16+
#
917
# ## 8.3.0 (2024-12-27)
1018
#
1119
# ### Added
@@ -304,13 +312,15 @@ PODMAN="$(if command -v podman >/dev/null 2>&1; then echo podman; else echo dock
304312

305313
if ! command -v curl >/dev/null 2>&1; then
306314
if ! command -v wget >/dev/null 2>&1; then
315+
# shellcheck disable=SC2016
307316
errr 'either `curl` or `wget` must be installed for this script to work.'
308317

309318
exit 1
310319
fi
311320
fi
312321

313322
if ! command -v "${PODMAN}" >/dev/null 2>&1; then
323+
# shellcheck disable=SC2016
314324
errr 'either `podman` or `docker` must be installed for this script to work.'
315325

316326
exit 1
@@ -357,6 +367,10 @@ EOF
357367
exit 1
358368
fi
359369

370+
# The following variables comprise a pseudo associative array of project names to source repositories.
371+
# You only need to set a SOURCES variable if the project name does not match the source repository name.
372+
# You can get a key identifier using the `identifier` function.
373+
# To look up the value of any pseudo associative array, use the `aget` function.
360374
SOURCES_as_code='as-code-docs'
361375
SOURCES_enterprise_metrics='backend-enterprise'
362376
SOURCES_enterprise_metrics_='backend-enterprise'
@@ -366,24 +380,34 @@ SOURCES_grafana_cloud_alerting_and_irm_slo='slo'
366380
SOURCES_grafana_cloud_k6='k6-docs'
367381
SOURCES_grafana_cloud_data_configuration_integrations='cloud-onboarding'
368382
SOURCES_grafana_cloud_frontend_observability_faro_web_sdk='faro-web-sdk'
383+
SOURCES_grafana_cloud_send_data_fleet_management='fleet-management'
369384
SOURCES_helm_charts_mimir_distributed='mimir'
370385
SOURCES_helm_charts_tempo_distributed='tempo'
371386
SOURCES_opentelemetry='opentelemetry-docs'
372387
SOURCES_resources='website'
373388

389+
# The following variables comprise a pseudo associative array of project names to versions.
390+
# You only need to set a VERSIONS variable if it is not the default of 'latest'.
391+
# You can get a key identifier using the `identifier` function.
392+
# To look up the value of any pseudo associative array, use the `aget` function.
374393
VERSIONS_as_code='UNVERSIONED'
375394
VERSIONS_grafana_cloud='UNVERSIONED'
376395
VERSIONS_grafana_cloud_alerting_and_irm_machine_learning='UNVERSIONED'
377396
VERSIONS_grafana_cloud_alerting_and_irm_slo='UNVERSIONED'
378397
VERSIONS_grafana_cloud_k6='UNVERSIONED'
379398
VERSIONS_grafana_cloud_data_configuration_integrations='UNVERSIONED'
380399
VERSIONS_grafana_cloud_frontend_observability_faro_web_sdk='UNVERSIONED'
400+
VERSIONS_grafana_cloud_send_data_fleet_management='UNVERSIONED'
381401
VERSIONS_opentelemetry='UNVERSIONED'
382402
VERSIONS_resources='UNVERSIONED'
383403
VERSIONS_technical_documentation='UNVERSIONED'
384404
VERSIONS_website='UNVERSIONED'
385405
VERSIONS_writers_toolkit='UNVERSIONED'
386406

407+
# The following variables comprise a pseudo associative array of project names to source repository paths.
408+
# You only need to set a PATHS variable if it is not the default of 'docs/sources'.
409+
# You can get a key identifier using the `identifier` function.
410+
# To look up the value of any pseudo associative array, use the `aget` function.
387411
PATHS_grafana_cloud='content/docs/grafana-cloud'
388412
PATHS_helm_charts_mimir_distributed='docs/sources/helm-charts/mimir-distributed'
389413
PATHS_helm_charts_tempo_distributed='docs/sources/helm-charts/tempo-distributed'
@@ -816,7 +840,9 @@ EOF
816840
case "${OUTPUT_FORMAT}" in
817841
human)
818842
if ! command -v jq >/dev/null 2>&1; then
843+
# shellcheck disable=SC2016
819844
errr '`jq` must be installed for the `doc-validator` target to work.'
845+
# shellcheck disable=SC2016
820846
note 'To install `jq`, refer to https://jqlang.github.io/jq/download/,'
821847

822848
exit 1

0 commit comments

Comments
 (0)