From 40e5395db6c7dcc4ecfdc219e3e5e1fb72650558 Mon Sep 17 00:00:00 2001 From: Ville Ojamo <14869000+bluikko@users.noreply.github.com> Date: Sat, 2 Aug 2025 13:26:14 +0700 Subject: [PATCH] doc: Use ref instead of full URLs for intra-docs links Labels mostly existed already but add labels in 2 files. Add missing closing quotation mark in rados/troubleshooting/log-and-debug.rst. Signed-off-by: Ville Ojamo <14869000+bluikko@users.noreply.github.com> --- doc/jaegertracing/index.rst | 1 + doc/man/8/ceph.rst | 1 + doc/rados/operations/devices.rst | 7 +++---- doc/rados/troubleshooting/log-and-debug.rst | 4 ++-- doc/radosgw/lua-scripting.rst | 2 +- doc/radosgw/multisite.rst | 5 ++--- doc/radosgw/pools.rst | 5 ++--- doc/rbd/iscsi-target-cli.rst | 3 +-- doc/start/hardware-recommendations.rst | 5 ++--- 9 files changed, 15 insertions(+), 18 deletions(-) diff --git a/doc/jaegertracing/index.rst b/doc/jaegertracing/index.rst index 9d2678ffde566..43a145722f8ef 100644 --- a/doc/jaegertracing/index.rst +++ b/doc/jaegertracing/index.rst @@ -72,6 +72,7 @@ For single node testing Jaeger opentelemetry can be deployed using: to port the configured 6799. Use the option "--processor.jaeger-compact.server-host-port=6799" for manual Jaeger deployments. +.. _jaegertracing-enable: HOW TO ENABLE TRACING IN CEPH ----------------------------- diff --git a/doc/man/8/ceph.rst b/doc/man/8/ceph.rst index 44f5a923e9626..59a57cde0beae 100644 --- a/doc/man/8/ceph.rst +++ b/doc/man/8/ceph.rst @@ -305,6 +305,7 @@ Usage:: ceph config-key set {} +.. _man-ceph-daemon: daemon ------ diff --git a/doc/rados/operations/devices.rst b/doc/rados/operations/devices.rst index f92f622d53003..64a6c736a3630 100644 --- a/doc/rados/operations/devices.rst +++ b/doc/rados/operations/devices.rst @@ -57,10 +57,9 @@ information, run the following command: The ``[ident|fault]`` parameter determines which kind of light will blink. By default, the `identification` light is used. -.. note:: This command works only if the Cephadm or the Rook `orchestrator - `_ - module is enabled. To see which orchestrator module is enabled, run the - following command: +.. note:: This command works only if the Cephadm or the Rook + :ref:`orchestrator ` module is enabled. To see + which orchestrator module is enabled, run the following command: .. prompt:: bash $ diff --git a/doc/rados/troubleshooting/log-and-debug.rst b/doc/rados/troubleshooting/log-and-debug.rst index 46775df9d051f..66996b5e4ae25 100644 --- a/doc/rados/troubleshooting/log-and-debug.rst +++ b/doc/rados/troubleshooting/log-and-debug.rst @@ -187,9 +187,9 @@ following conditions are true: - a fatal signal has been raised or - an assertion within Ceph code has been triggered or - sending in-memory logs to the output log has been manually triggered. - Consult `the portion of the "Ceph Administration Tool documentation + Consult :ref:`the portion of the "Ceph Administration Tool" documentation that provides an example of how to submit admin socket commands - `_ for more detail. + ` for more detail. Log levels and memory levels can be set either together or separately. If a subsystem is assigned a single value, then that value determines both the log diff --git a/doc/radosgw/lua-scripting.rst b/doc/radosgw/lua-scripting.rst index 8f418aaa84a10..ef1729cb9cee1 100644 --- a/doc/radosgw/lua-scripting.rst +++ b/doc/radosgw/lua-scripting.rst @@ -511,7 +511,7 @@ Tracing is disabled by default, so we should enable tracing for this specific bu end -If `tracing is enabled `_ on the RGW, the value of Request.Trace.Enable is true, so we should disable tracing for all other requests that do not match the bucket name. +If :ref:`tracing is enabled ` on the RGW, the value of Request.Trace.Enable is true, so we should disable tracing for all other requests that do not match the bucket name. In the ``prerequest`` context: .. code-block:: lua diff --git a/doc/radosgw/multisite.rst b/doc/radosgw/multisite.rst index 731923ad64f80..e7dc54301eca7 100644 --- a/doc/radosgw/multisite.rst +++ b/doc/radosgw/multisite.rst @@ -1536,9 +1536,8 @@ Setting a Zone Configuring a zone involves specifying a series of Ceph Object Gateway pools. For consistency, we recommend using a pool prefix that is the -same as the zone name. See -`Pools `__ -for details of configuring pools. +same as the zone name. See :ref:`rados_pools` for details of +configuring pools. To set a zone, create a JSON object consisting of the pools, save the object to a file (e.g., ``zone.json``); then, run the following diff --git a/doc/radosgw/pools.rst b/doc/radosgw/pools.rst index 70a5b4cfd669d..2bca23fa924bb 100644 --- a/doc/radosgw/pools.rst +++ b/doc/radosgw/pools.rst @@ -15,9 +15,8 @@ When ``radosgw`` first tries to operate on a zone pool that does not exist, it will create that pool with the default values from ``osd pool default pg num`` and ``osd pool default pgp num``. These defaults are sufficient for some pools, but others (especially those listed in ``placement_pools`` for the bucket index -and data) will require additional tuning. See `Pools -`__ for details -on pool creation. +and data) will require additional tuning. See :ref:`rados_pools` for details on +pool creation. .. _radosgw-pool-namespaces: diff --git a/doc/rbd/iscsi-target-cli.rst b/doc/rbd/iscsi-target-cli.rst index 44da5600068bf..211a96e6ad465 100644 --- a/doc/rbd/iscsi-target-cli.rst +++ b/doc/rbd/iscsi-target-cli.rst @@ -89,8 +89,7 @@ For rpm based instructions execute the following commands: ceph osd lspools If it does not exist instructions for creating pools can be found on the - `RADOS pool operations page - `_. + :ref:`RADOS pool operations page `. #. As ``root``, on a iSCSI gateway node, create a file named ``iscsi-gateway.cfg`` in the ``/etc/ceph/`` directory: diff --git a/doc/start/hardware-recommendations.rst b/doc/start/hardware-recommendations.rst index a394fa36ace35..7a10315724b7e 100644 --- a/doc/start/hardware-recommendations.rst +++ b/doc/start/hardware-recommendations.rst @@ -173,8 +173,8 @@ drives: For more information on how to effectively use a mix of fast drives and slow drives in -your Ceph cluster, see the `block and block.db`_ section of the Bluestore -Configuration Reference. +your Ceph cluster, see the :ref:`block and block.db ` +section of the Bluestore Configuration Reference. Hard Disk Drives ---------------- @@ -613,7 +613,6 @@ found above and elsewhere within this documentation. -.. _block and block.db: https://docs.ceph.com/en/latest/rados/configuration/bluestore-config-ref/#block-and-block-db .. _Ceph blog: https://ceph.com/community/blog/ .. _Ceph Write Throughput 1: http://ceph.com/community/ceph-performance-part-1-disk-controller-write-throughput/ .. _Ceph Write Throughput 2: http://ceph.com/community/ceph-performance-part-2-write-throughput-without-ssd-journals/ -- 2.39.5