Skip to content

Commit 0584b60

Browse files
Update make docs procedure (#3802)
* Update `make docs` procedure * Update `make docs` procedure --------- Co-authored-by: grafanabot <[email protected]>
1 parent 5b3ff8f commit 0584b60

File tree

1 file changed

+24
-8
lines changed

1 file changed

+24
-8
lines changed

docs/make-docs

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,28 @@
66
# [Semantic versioning](https://semver.org/) is used to help the reader identify the significance of changes.
77
# Changes are relevant to this script and the support docs.mk GNU Make interface.
88
#
9+
# ## 8.3.0 (2024-12-27)
10+
#
11+
# ### Added
12+
#
13+
# - Debug output of the final command when DEBUG=true.
14+
#
15+
# Useful to inspect if the script is correctly constructing the final command.
16+
#
17+
# ## 8.2.0 (2024-12-22)
18+
#
19+
# ### Removed
20+
#
21+
# - Special cases for Oracle and Datadog plugins now that they exist in the plugins monorepo.
22+
#
923
# ## 8.1.0 (2024-08-22)
1024
#
1125
# ### Added
1226
#
1327
# - Additional website mounts for projects that use the website repository.
1428
#
1529
# Mounts are required for `make docs` to work in the website repository or with the website project.
16-
# The Makefile is also mounted for convenient development of the procedure that repository.
30+
# The Makefile is also mounted for convenient development of the procedure in that repository.
1731
#
1832
# ## 8.0.1 (2024-07-01)
1933
#
@@ -355,8 +369,6 @@ SOURCES_grafana_cloud_frontend_observability_faro_web_sdk='faro-web-sdk'
355369
SOURCES_helm_charts_mimir_distributed='mimir'
356370
SOURCES_helm_charts_tempo_distributed='tempo'
357371
SOURCES_opentelemetry='opentelemetry-docs'
358-
SOURCES_plugins_grafana_datadog_datasource='datadog-datasource'
359-
SOURCES_plugins_grafana_oracle_datasource='oracle-datasource'
360372
SOURCES_resources='website'
361373

362374
VERSIONS_as_code='UNVERSIONED'
@@ -367,8 +379,6 @@ VERSIONS_grafana_cloud_k6='UNVERSIONED'
367379
VERSIONS_grafana_cloud_data_configuration_integrations='UNVERSIONED'
368380
VERSIONS_grafana_cloud_frontend_observability_faro_web_sdk='UNVERSIONED'
369381
VERSIONS_opentelemetry='UNVERSIONED'
370-
VERSIONS_plugins_grafana_datadog_datasource='latest'
371-
VERSIONS_plugins_grafana_oracle_datasource='latest'
372382
VERSIONS_resources='UNVERSIONED'
373383
VERSIONS_technical_documentation='UNVERSIONED'
374384
VERSIONS_website='UNVERSIONED'
@@ -378,8 +388,6 @@ PATHS_grafana_cloud='content/docs/grafana-cloud'
378388
PATHS_helm_charts_mimir_distributed='docs/sources/helm-charts/mimir-distributed'
379389
PATHS_helm_charts_tempo_distributed='docs/sources/helm-charts/tempo-distributed'
380390
PATHS_mimir='docs/sources/mimir'
381-
PATHS_plugins_grafana_datadog_datasource='docs/sources'
382-
PATHS_plugins_grafana_oracle_datasource='docs/sources'
383391
PATHS_resources='content'
384392
PATHS_tempo='docs/sources/tempo'
385393
PATHS_website='content'
@@ -631,7 +639,7 @@ POSIX_HERESTRING
631639

632640
case "${_project}" in
633641
# Workaround for arbitrary mounts where the version field is expected to be the local directory
634-
# and the repo field is expected to be the container directory.
642+
# and the repo field is expected to be the container directory.
635643
arbitrary)
636644
echo "${_project}^${_version}^${_repo}^" # TODO
637645
;;
@@ -801,6 +809,10 @@ case "${image}" in
801809
| sed "s#$(proj_dst "${proj}")#sources#"
802810
EOF
803811

812+
if [ -n "${DEBUG}" ]; then
813+
debg "${cmd}"
814+
fi
815+
804816
case "${OUTPUT_FORMAT}" in
805817
human)
806818
if ! command -v jq >/dev/null 2>&1; then
@@ -837,6 +849,10 @@ EOF
837849
/hugo/content/docs
838850
EOF
839851

852+
if [ -n "${DEBUG}" ]; then
853+
debg "${cmd}"
854+
fi
855+
840856
case "${OUTPUT_FORMAT}" in
841857
human)
842858
${cmd} --output=line \

0 commit comments

Comments
 (0)