public inbox for pbs-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Maximiliano Sandoval <m.sandoval@proxmox.com>
To: pbs-devel@lists.proxmox.com
Subject: [PATCH offline-mirror 1/2] docs: offline-media: fix refence to example
Date: Fri, 13 Mar 2026 14:33:55 +0100	[thread overview]
Message-ID: <20260313133358.108895-1-m.sandoval@proxmox.com> (raw)

At the moment the "Example: Local HTTP Server" section generates a link
to `#example-local-http-server`. We set the existing reference
explicitly instead of relying on the section title.

Signed-off-by: Maximiliano Sandoval <m.sandoval@proxmox.com>
---

Notes:
    Without this patch the rendered docs will point to a non existent
    section (commits) `#id1` and the link will be rendered literally as
    "`Local HTTP Server`_" (displaying the ` and _ characters literally).

 docs/offline-media.rst | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/docs/offline-media.rst b/docs/offline-media.rst
index 7f02ad5..b8de52a 100644
--- a/docs/offline-media.rst
+++ b/docs/offline-media.rst
@@ -83,6 +83,8 @@ one or more of either the one of a Debian or Proxmox project, for example ``pve-
 Now you should be able to upgrade like normally, and don't forget to disable the repository entry
 again until next time, once your done.
 
+.. _example-local-http-server:
+
 Example: Local HTTP Server
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 
@@ -110,7 +112,7 @@ offline-key`` directly or follow the respective step when doing the guided setup
 ``proxmox-offline-mirror-helper setup`` command.
 
 The ``offline-key`` command supports both local mountpoints and HTTP URLs. When using an HTTP
-server (as described in the `Local HTTP Server`_ section), you can activate subscription keys
+server (as described in the :ref:`example-local-http-server` section), you can activate subscription keys
 directly from the HTTP URL without needing to mount the medium locally:
 
 .. code-block:: console
-- 
2.47.3





             reply	other threads:[~2026-03-13 13:34 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-03-13 13:33 Maximiliano Sandoval [this message]
2026-03-13 13:33 ` [PATCH offline-mirror 2/2] docs: offline-media: replace an with a Maximiliano Sandoval

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=20260313133358.108895-1-m.sandoval@proxmox.com \
    --to=m.sandoval@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