[pbs-devel] [PATCH proxmox-backup 2/2] docs: fix warnings in external-metric-server page

Gabriel Goller g.goller at proxmox.com
Thu Oct 10 15:26:42 CEST 2024


Rename external-metric-server page and fix code-block to remove some
warnings.

Signed-off-by: Gabriel Goller <g.goller at proxmox.com>
---
 ...c_server.rst => external-metric-server.rst} | 18 ++++++++----------
 docs/sysadmin.rst                              |  2 +-
 2 files changed, 9 insertions(+), 11 deletions(-)
 rename docs/{external_metric_server.rst => external-metric-server.rst} (91%)

diff --git a/docs/external_metric_server.rst b/docs/external-metric-server.rst
similarity index 91%
rename from docs/external_metric_server.rst
rename to docs/external-metric-server.rst
index 097a8cc3a1c0..f65082cc4976 100644
--- a/docs/external_metric_server.rst
+++ b/docs/external-metric-server.rst
@@ -1,5 +1,3 @@
-.. _external_metric_server:
-
 External Metric Server
 ----------------------
 
@@ -44,14 +42,14 @@ necessary.
 
 Here is an example configuration for InfluxDB (on your InfluxDB server):
 
-----
-[[udp]]
-   enabled = true
-   bind-address = "0.0.0.0:8089"
-   database = "proxmox"
-   batch-size = 1000
-   batch-timeout = "1s"
-----
+.. code-block:: console
+
+   [[udp]]
+      enabled = true
+      bind-address = "0.0.0.0:8089"
+      database = "proxmox"
+      batch-size = 1000
+      batch-timeout = "1s"
 
 With this configuration, the InfluxDB server listens on all IP addresses on
 port 8089, and writes the data in the *proxmox* database.
diff --git a/docs/sysadmin.rst b/docs/sysadmin.rst
index d42b6a9b2af1..ec124d41a857 100644
--- a/docs/sysadmin.rst
+++ b/docs/sysadmin.rst
@@ -30,7 +30,7 @@ please refer to the standard Debian documentation.
 
 .. include:: certificate-management.rst
 
-.. include:: external_metric_server.rst
+.. include:: external-metric-server.rst
 
 .. include:: services.rst
 
-- 
2.39.5





More information about the pbs-devel mailing list