public inbox for pbs-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Gabriel Goller <g.goller@proxmox.com>
To: pbs-devel@lists.proxmox.com
Subject: [pbs-devel] [PATCH proxmox-backup 2/2] docs: fix warnings in external-metric-server page
Date: Thu, 10 Oct 2024 15:26:42 +0200	[thread overview]
Message-ID: <20241010132642.348202-2-g.goller@proxmox.com> (raw)
In-Reply-To: <20241010132642.348202-1-g.goller@proxmox.com>

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

Signed-off-by: Gabriel Goller <g.goller@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



_______________________________________________
pbs-devel mailing list
pbs-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel


      reply	other threads:[~2024-10-10 13:26 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-10-10 13:26 [pbs-devel] [PATCH proxmox-backup 1/2] docs: add node.cfg man page Gabriel Goller
2024-10-10 13:26 ` Gabriel Goller [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20241010132642.348202-2-g.goller@proxmox.com \
    --to=g.goller@proxmox.com \
    --cc=pbs-devel@lists.proxmox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal