Usage guides: Add documentation URLs to each configuration file

amotl · amotl · commit 17253d46b42d · 2025-10-06T22:55:37.000+02:00
This gives users more orientation after downloading usage guide assets.
diff --git a/docs/integrate/amqp/compose.yaml b/docs/integrate/amqp/compose.yaml
@@ -1,4 +1,5 @@
 # Service composition file for Docker Compose or Podman Compose
+# https://cratedb.com/docs/guide/integrate/amqp/
 
 services:
 
diff --git a/docs/integrate/collectd/Dockerfile b/docs/integrate/collectd/Dockerfile
@@ -1,3 +1,5 @@
+# https://cratedb.com/docs/guide/integrate/collectd/
+
 FROM docker.io/debian:13-slim
 
 # Configure system environment.
diff --git a/docs/integrate/collectd/collectd-cratedb.conf b/docs/integrate/collectd/collectd-cratedb.conf
@@ -1,4 +1,6 @@
 # collectd configuration for storing metrics into CrateDB.
+# https://cratedb.com/docs/guide/integrate/collectd/
+
 # https://collectd.org/documentation/manpages/collectd.conf.html#plugin-postgresql
 
 LoadPlugin postgresql
diff --git a/docs/integrate/collectd/collectd-telegraf.conf b/docs/integrate/collectd/collectd-telegraf.conf
@@ -1,4 +1,6 @@
 # collectd configuration for sending metrics to Telegraf.
+# https://cratedb.com/docs/guide/integrate/collectd/
+
 # https://collectd.org/documentation/manpages/collectd.conf.html#plugin-network
 
 LoadPlugin network
diff --git a/docs/integrate/collectd/compose.yaml b/docs/integrate/collectd/compose.yaml
@@ -1,4 +1,5 @@
 # Service composition file for Docker Compose or Podman Compose
+# https://cratedb.com/docs/guide/integrate/collectd/
 
 services:
 
diff --git a/docs/integrate/collectd/telegraf.conf b/docs/integrate/collectd/telegraf.conf
@@ -1,3 +1,6 @@
+# Telegraf configuration with CrateDB output.
+# https://cratedb.com/docs/guide/integrate/collectd/
+
 [[inputs.socket_listener]]
   service_address = "udp://:25826"
 
diff --git a/docs/integrate/influxdb/compose.yaml b/docs/integrate/influxdb/compose.yaml
@@ -1,4 +1,5 @@
 # Service composition file for Docker Compose or Podman Compose
+# https://cratedb.com/docs/guide/integrate/influxdb/
 
 services:
 
diff --git a/docs/integrate/mongodb/compose.yaml b/docs/integrate/mongodb/compose.yaml
@@ -1,4 +1,5 @@
 # Service composition file for Docker Compose or Podman Compose
+# https://cratedb.com/docs/guide/integrate/mongodb/
 
 services:
 
diff --git a/docs/integrate/mqtt/compose.yaml b/docs/integrate/mqtt/compose.yaml
@@ -1,4 +1,5 @@
 # Service composition file for Docker Compose or Podman Compose
+# https://cratedb.com/docs/guide/integrate/mqtt/
 
 services:
 
diff --git a/docs/integrate/mysql/compose.yaml b/docs/integrate/mysql/compose.yaml
@@ -1,4 +1,5 @@
 # Service composition file for Docker Compose or Podman Compose
+# https://cratedb.com/docs/guide/integrate/mysql/
 
 services:
 
diff --git a/docs/integrate/opentelemetry/collector/compose.yaml b/docs/integrate/opentelemetry/collector/compose.yaml
@@ -1,4 +1,5 @@
 # Service composition file for Docker Compose or Podman Compose
+# https://cratedb.com/docs/guide/integrate/opentelemetry/
 
 services:
 
diff --git a/docs/integrate/opentelemetry/collector/cratedb-prometheus-adapter.yaml b/docs/integrate/opentelemetry/collector/cratedb-prometheus-adapter.yaml
@@ -1,3 +1,5 @@
+# https://cratedb.com/docs/guide/integrate/opentelemetry/
+
 cratedb_endpoints:
 - host: "cratedb"           # Host to connect to (default: "localhost").
   port: 5432                # Port to connect to (default: 5432).
diff --git a/docs/integrate/opentelemetry/collector/ddl.sql b/docs/integrate/opentelemetry/collector/ddl.sql
@@ -1,3 +1,5 @@
+-- https://cratedb.com/docs/guide/integrate/opentelemetry/
+
 CREATE TABLE IF NOT EXISTS "testdrive"."metrics" (
     "timestamp" TIMESTAMP,
     "labels_hash" TEXT,
diff --git a/docs/integrate/opentelemetry/collector/example.py b/docs/integrate/opentelemetry/collector/example.py
@@ -1,4 +1,5 @@
 # OpenTelemetry demo application.
+# https://cratedb.com/docs/guide/integrate/opentelemetry/
 from opentelemetry import metrics
 
 
diff --git a/docs/integrate/opentelemetry/collector/otelcol.yaml b/docs/integrate/opentelemetry/collector/otelcol.yaml
@@ -1,4 +1,5 @@
 # OpenTelemetry Collector configuration file
+# https://cratedb.com/docs/guide/integrate/opentelemetry/
 #
 # https://github.com/open-telemetry/opentelemetry-collector-releases/blob/main/distributions/otelcol-contrib/config.yaml
 # https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/prometheusremotewriteexporter
diff --git a/docs/integrate/opentelemetry/telegraf/compose.yaml b/docs/integrate/opentelemetry/telegraf/compose.yaml
@@ -1,4 +1,5 @@
 # Service composition file for Docker Compose or Podman Compose
+# https://cratedb.com/docs/guide/integrate/opentelemetry/
 
 services:
 
diff --git a/docs/integrate/opentelemetry/telegraf/example.py b/docs/integrate/opentelemetry/telegraf/example.py
@@ -1,4 +1,5 @@
 # OpenTelemetry demo application.
+# https://cratedb.com/docs/guide/integrate/opentelemetry/
 from opentelemetry import metrics
 
 
diff --git a/docs/integrate/opentelemetry/telegraf/telegraf.conf b/docs/integrate/opentelemetry/telegraf/telegraf.conf
@@ -1,3 +1,6 @@
+# Telegraf configuration with CrateDB output.
+# https://cratedb.com/docs/guide/integrate/opentelemetry/
+
 # OpenTelemetry Input Plugin
 # https://github.com/influxdata/telegraf/blob/release-1.36/plugins/inputs/opentelemetry/README.md
 [[inputs.opentelemetry]]
diff --git a/docs/integrate/oracle/compose.yaml b/docs/integrate/oracle/compose.yaml
@@ -1,4 +1,5 @@
 # Service composition file for Docker Compose or Podman Compose
+# https://cratedb.com/docs/guide/integrate/oracle/
 
 services:
 
diff --git a/docs/integrate/oracle/init.sql b/docs/integrate/oracle/init.sql
@@ -1,3 +1,5 @@
+-- https://cratedb.com/docs/guide/integrate/oracle/
+
 DROP TABLE demo;
 CREATE TABLE IF NOT EXISTS demo (id LONG, temperature FLOAT, humidity FLOAT);
 INSERT INTO demo (id, temperature, humidity) VALUES (1, 42.84, 83.1);
diff --git a/docs/integrate/postgresql/compose.yaml b/docs/integrate/postgresql/compose.yaml
@@ -1,4 +1,5 @@
 # Service composition file for Docker Compose or Podman Compose
+# https://cratedb.com/docs/guide/integrate/postgresql/
 
 services:
 
diff --git a/docs/integrate/statsd/compose.yaml b/docs/integrate/statsd/compose.yaml
@@ -1,4 +1,5 @@
 # Service composition file for Docker Compose or Podman Compose
+# https://cratedb.com/docs/guide/integrate/statsd/
 
 services:
 
diff --git a/docs/integrate/statsd/telegraf.conf b/docs/integrate/statsd/telegraf.conf
@@ -1,3 +1,6 @@
+# Telegraf configuration with CrateDB output.
+# https://cratedb.com/docs/guide/integrate/statsd/
+
 # StatsD Input Plugin
 # https://github.com/influxdata/telegraf/tree/master/plugins/inputs/statsd
 [[inputs.statsd]]
diff --git a/docs/integrate/telegraf/compose.yaml b/docs/integrate/telegraf/compose.yaml
@@ -1,4 +1,5 @@
 # Service composition file for Docker Compose or Podman Compose
+# https://cratedb.com/docs/guide/integrate/telegraf/
 
 services:
 
diff --git a/docs/integrate/telegraf/telegraf.conf b/docs/integrate/telegraf/telegraf.conf
@@ -1,3 +1,6 @@
+# Telegraf configuration with CrateDB output.
+# https://cratedb.com/docs/guide/integrate/telegraf/
+
 # Telegraf Configuration
 #
 # Telegraf is entirely plugin driven. All metrics are gathered from the

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`# Service composition file for Docker Compose or Podman Compose`
	`2`	`+# https://cratedb.com/docs/guide/integrate/amqp/`
`2`	`3`
`3`	`4`	`services:`
`4`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# https://cratedb.com/docs/guide/integrate/collectd/`
	`2`	`+`
`1`	`3`	`FROM docker.io/debian:13-slim`
`2`	`4`
`3`	`5`	`# Configure system environment.`