1
1
#! /bin/sh
2
+ # shellcheck disable=SC2034
3
+ #
2
4
# The source of this file is https://raw.githubusercontent.com/grafana/writers-toolkit/main/docs/make-docs.
3
5
# # `make-docs` procedure changelog
4
6
#
5
7
# Updates should conform to the guidelines in https://keepachangelog.com/en/1.1.0/.
6
8
# [Semantic versioning](https://semver.org/) is used to help the reader identify the significance of changes.
7
9
# Changes are relevant to this script and the support docs.mk GNU Make interface.
8
10
#
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
+ #
9
17
# ## 8.3.0 (2024-12-27)
10
18
#
11
19
# ### Added
@@ -304,13 +312,15 @@ PODMAN="$(if command -v podman >/dev/null 2>&1; then echo podman; else echo dock
304
312
305
313
if ! command -v curl > /dev/null 2>&1 ; then
306
314
if ! command -v wget > /dev/null 2>&1 ; then
315
+ # shellcheck disable=SC2016
307
316
errr ' either `curl` or `wget` must be installed for this script to work.'
308
317
309
318
exit 1
310
319
fi
311
320
fi
312
321
313
322
if ! command -v " ${PODMAN} " > /dev/null 2>&1 ; then
323
+ # shellcheck disable=SC2016
314
324
errr ' either `podman` or `docker` must be installed for this script to work.'
315
325
316
326
exit 1
357
367
exit 1
358
368
fi
359
369
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.
360
374
SOURCES_as_code=' as-code-docs'
361
375
SOURCES_enterprise_metrics=' backend-enterprise'
362
376
SOURCES_enterprise_metrics_=' backend-enterprise'
@@ -366,24 +380,34 @@ SOURCES_grafana_cloud_alerting_and_irm_slo='slo'
366
380
SOURCES_grafana_cloud_k6=' k6-docs'
367
381
SOURCES_grafana_cloud_data_configuration_integrations=' cloud-onboarding'
368
382
SOURCES_grafana_cloud_frontend_observability_faro_web_sdk=' faro-web-sdk'
383
+ SOURCES_grafana_cloud_send_data_fleet_management=' fleet-management'
369
384
SOURCES_helm_charts_mimir_distributed=' mimir'
370
385
SOURCES_helm_charts_tempo_distributed=' tempo'
371
386
SOURCES_opentelemetry=' opentelemetry-docs'
372
387
SOURCES_resources=' website'
373
388
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.
374
393
VERSIONS_as_code=' UNVERSIONED'
375
394
VERSIONS_grafana_cloud=' UNVERSIONED'
376
395
VERSIONS_grafana_cloud_alerting_and_irm_machine_learning=' UNVERSIONED'
377
396
VERSIONS_grafana_cloud_alerting_and_irm_slo=' UNVERSIONED'
378
397
VERSIONS_grafana_cloud_k6=' UNVERSIONED'
379
398
VERSIONS_grafana_cloud_data_configuration_integrations=' UNVERSIONED'
380
399
VERSIONS_grafana_cloud_frontend_observability_faro_web_sdk=' UNVERSIONED'
400
+ VERSIONS_grafana_cloud_send_data_fleet_management=' UNVERSIONED'
381
401
VERSIONS_opentelemetry=' UNVERSIONED'
382
402
VERSIONS_resources=' UNVERSIONED'
383
403
VERSIONS_technical_documentation=' UNVERSIONED'
384
404
VERSIONS_website=' UNVERSIONED'
385
405
VERSIONS_writers_toolkit=' UNVERSIONED'
386
406
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.
387
411
PATHS_grafana_cloud=' content/docs/grafana-cloud'
388
412
PATHS_helm_charts_mimir_distributed=' docs/sources/helm-charts/mimir-distributed'
389
413
PATHS_helm_charts_tempo_distributed=' docs/sources/helm-charts/tempo-distributed'
816
840
case " ${OUTPUT_FORMAT} " in
817
841
human)
818
842
if ! command -v jq > /dev/null 2>&1 ; then
843
+ # shellcheck disable=SC2016
819
844
errr ' `jq` must be installed for the `doc-validator` target to work.'
845
+ # shellcheck disable=SC2016
820
846
note ' To install `jq`, refer to https://jqlang.github.io/jq/download/,'
821
847
822
848
exit 1
0 commit comments