Skip to content

Commit 40e5395

Browse files
committed
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 <[email protected]>
1 parent 4dca855 commit 40e5395

File tree

9 files changed

+15
-18
lines changed

9 files changed

+15
-18
lines changed

doc/jaegertracing/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,7 @@ For single node testing Jaeger opentelemetry can be deployed using:
7272
to port the configured 6799. Use the option "--processor.jaeger-compact.server-host-port=6799" for manual Jaeger
7373
deployments.
7474

75+
.. _jaegertracing-enable:
7576

7677
HOW TO ENABLE TRACING IN CEPH
7778
-----------------------------

doc/man/8/ceph.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -305,6 +305,7 @@ Usage::
305305

306306
ceph config-key set <key> {<val>}
307307

308+
.. _man-ceph-daemon:
308309

309310
daemon
310311
------

doc/rados/operations/devices.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -57,10 +57,9 @@ information, run the following command:
5757
The ``[ident|fault]`` parameter determines which kind of light will blink. By
5858
default, the `identification` light is used.
5959

60-
.. note:: This command works only if the Cephadm or the Rook `orchestrator
61-
<https://docs.ceph.com/docs/master/mgr/orchestrator/#orchestrator-cli-module>`_
62-
module is enabled. To see which orchestrator module is enabled, run the
63-
following command:
60+
.. note:: This command works only if the Cephadm or the Rook
61+
:ref:`orchestrator <orchestrator-cli-module>` module is enabled. To see
62+
which orchestrator module is enabled, run the following command:
6463

6564
.. prompt:: bash $
6665

doc/rados/troubleshooting/log-and-debug.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -187,9 +187,9 @@ following conditions are true:
187187
- a fatal signal has been raised or
188188
- an assertion within Ceph code has been triggered or
189189
- sending in-memory logs to the output log has been manually triggered.
190-
Consult `the portion of the "Ceph Administration Tool documentation
190+
Consult :ref:`the portion of the "Ceph Administration Tool" documentation
191191
that provides an example of how to submit admin socket commands
192-
<http://docs.ceph.com/en/latest/man/8/ceph/#daemon>`_ for more detail.
192+
<man-ceph-daemon>` for more detail.
193193

194194
Log levels and memory levels can be set either together or separately. If a
195195
subsystem is assigned a single value, then that value determines both the log

doc/radosgw/lua-scripting.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -511,7 +511,7 @@ Tracing is disabled by default, so we should enable tracing for this specific bu
511511
end
512512
513513
514-
If `tracing is enabled <https://docs.ceph.com/en/latest/jaegertracing/#how-to-enable-tracing-in-ceph/>`_ 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.
514+
If :ref:`tracing is enabled <jaegertracing-enable>` 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.
515515
In the ``prerequest`` context:
516516

517517
.. code-block:: lua

doc/radosgw/multisite.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1536,9 +1536,8 @@ Setting a Zone
15361536

15371537
Configuring a zone involves specifying a series of Ceph Object Gateway
15381538
pools. For consistency, we recommend using a pool prefix that is the
1539-
same as the zone name. See
1540-
`Pools <http://docs.ceph.com/en/latest/rados/operations/pools/#pools>`__
1541-
for details of configuring pools.
1539+
same as the zone name. See :ref:`rados_pools` for details of
1540+
configuring pools.
15421541

15431542
To set a zone, create a JSON object consisting of the pools, save the
15441543
object to a file (e.g., ``zone.json``); then, run the following

doc/radosgw/pools.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,8 @@ When ``radosgw`` first tries to operate on a zone pool that does not exist, it
1515
will create that pool with the default values from ``osd pool default pg num``
1616
and ``osd pool default pgp num``. These defaults are sufficient for some pools,
1717
but others (especially those listed in ``placement_pools`` for the bucket index
18-
and data) will require additional tuning. See `Pools
19-
<http://docs.ceph.com/en/latest/rados/operations/pools/#pools>`__ for details
20-
on pool creation.
18+
and data) will require additional tuning. See :ref:`rados_pools` for details on
19+
pool creation.
2120

2221
.. _radosgw-pool-namespaces:
2322

doc/rbd/iscsi-target-cli.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,8 +89,7 @@ For rpm based instructions execute the following commands:
8989
ceph osd lspools
9090

9191
If it does not exist instructions for creating pools can be found on the
92-
`RADOS pool operations page
93-
<http://docs.ceph.com/en/latest/rados/operations/pools/>`_.
92+
:ref:`RADOS pool operations page <rados_pools>`.
9493

9594
#. As ``root``, on a iSCSI gateway node, create a file named
9695
``iscsi-gateway.cfg`` in the ``/etc/ceph/`` directory:

doc/start/hardware-recommendations.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -173,8 +173,8 @@ drives:
173173

174174
For more
175175
information on how to effectively use a mix of fast drives and slow drives in
176-
your Ceph cluster, see the `block and block.db`_ section of the Bluestore
177-
Configuration Reference.
176+
your Ceph cluster, see the :ref:`block and block.db <bluestore-mixed-device-config>`
177+
section of the Bluestore Configuration Reference.
178178

179179
Hard Disk Drives
180180
----------------
@@ -613,7 +613,6 @@ found above and elsewhere within this documentation.
613613

614614

615615

616-
.. _block and block.db: https://docs.ceph.com/en/latest/rados/configuration/bluestore-config-ref/#block-and-block-db
617616
.. _Ceph blog: https://ceph.com/community/blog/
618617
.. _Ceph Write Throughput 1: http://ceph.com/community/ceph-performance-part-1-disk-controller-write-throughput/
619618
.. _Ceph Write Throughput 2: http://ceph.com/community/ceph-performance-part-2-write-throughput-without-ssd-journals/

0 commit comments

Comments
 (0)