From: Ville Ojamo <14869000+bluikko@users.noreply.github.com>
Date: Thu, 15 May 2025 09:46:21 +0000 (+0700)
Subject: doc/radosgw: Use ref for hyperlinking to multisite
X-Git-Tag: v19.2.3~143^2
X-Git-Url: http://git.apps.os.sepia.ceph.com/?a=commitdiff_plain;h=b853864154894f4bdf5ee702df3a4ae6aaa4825c;p=ceph.git

doc/radosgw: Use ref for hyperlinking to multisite

Use validated ":ref:" hyperlinks instead of "external links" in "target
definitions" when linking within the Ceph docs:
- Update to use existing label in multisite.rst.
- Remove unused "target definitions".

Also use existing label for linking from multisite.rst.
Fix a broken link within multisite.rst.

The rendered PR should look the same as the old docs, only differing in
the source RST.

Signed-off-by: Ville Ojamo <14869000+bluikko@users.noreply.github.com>
(cherry picked from commit e296c756ca191753080cb65e3df4bf3bb160398b)
---

diff --git a/doc/radosgw/multisite.rst b/doc/radosgw/multisite.rst
index b4cedad12a268..3a99c357e66b9 100644
--- a/doc/radosgw/multisite.rst
+++ b/doc/radosgw/multisite.rst
@@ -144,8 +144,8 @@ master zonegroup.
 See `Pools`_ for instructions on creating and tuning pools for Ceph Object
 Storage.
 
-See `Sync Policy Config`_ for instructions on defining fine-grained bucket sync
-policy rules.
+See :ref:`Sync Policy Config <radosgw-multisite-sync-policy>` for instructions
+on defining fine-grained bucket sync policy rules.
 
 .. _master-zone-label:
 
@@ -832,9 +832,8 @@ to a multi-site system, follow these steps:
 
       systemctl restart ceph-radosgw@rgw.`hostname -s`
 
-After completing this procedure, proceed to `Configure a Secondary
-Zone <#configure-secondary-zones>`_ and create a secondary zone
-in the master zonegroup.
+After completing this procedure, proceed to :ref:`secondary-zone-label`
+and create a secondary zone in the master zonegroup.
 
 Multi-Site Configuration Reference
 ==================================
@@ -1604,4 +1603,3 @@ instance.
 
 
 .. _`Pools`: ../pools
-.. _`Sync Policy Config`: ../multisite-sync-policy
diff --git a/doc/radosgw/placement.rst b/doc/radosgw/placement.rst
index 391e7fc83b8d0..1589c6a36792e 100644
--- a/doc/radosgw/placement.rst
+++ b/doc/radosgw/placement.rst
@@ -94,7 +94,7 @@ The zone placement configuration can be queried with:
       ...
   }
 
-.. note:: If you have not done any previous `Multisite Configuration`_,
+.. note:: If you have not done any previous :ref:`Multisite Configuration <multisite>`,
           a ``default`` zone and zonegroup are created for you, and changes
           to the zone/zonegroup will not take effect until the Ceph Object
           Gateways are restarted. If you have created a realm for multisite,
@@ -267,4 +267,3 @@ names be used with Ceph, including ``INTELLIGENT-TIERING``, ``STANDARD_IA``,
 libraries.
 
 .. _`Pools`: ../pools
-.. _`Multisite Configuration`: ../multisite
diff --git a/doc/radosgw/pools.rst b/doc/radosgw/pools.rst
index acd6a63211459..70a5b4cfd669d 100644
--- a/doc/radosgw/pools.rst
+++ b/doc/radosgw/pools.rst
@@ -5,8 +5,8 @@ Pools
 The Ceph Object Gateway uses several pools for its various storage needs,
 which are listed in the Zone object (see ``radosgw-admin zone get``). A
 single zone named ``default`` is created automatically with pool names
-starting with ``default.rgw.``, but a `Multisite Configuration`_ will have
-multiple zones.
+starting with ``default.rgw.``, but a :ref:`Multisite Configuration <multisite>`
+will have multiple zones.
 
 Tuning
 ======
@@ -51,4 +51,3 @@ the following pool entries use namespaces of the ``us-east.rgw.meta`` pool::
     "user_swift_pool": "us-east.rgw.meta:users.swift",
     "user_uid_pool": "us-east.rgw.meta:users.uid",
 
-.. _`Multisite Configuration`: ../multisite
diff --git a/doc/radosgw/s3/commons.rst b/doc/radosgw/s3/commons.rst
index 5047f8fdecc1f..b53c0b34b87c0 100644
--- a/doc/radosgw/s3/commons.rst
+++ b/doc/radosgw/s3/commons.rst
@@ -24,8 +24,8 @@ Plan`_ for more information.
 
 To configure virtual hosted buckets, you can either set ``rgw_dns_name =
 cname.domain.com`` in ``ceph.conf`` or add ``cname.domain.com`` to the list of
-``hostnames`` in your zonegroup configuration. See `Ceph Object Gateway -
-Multisite Configuration`_ for more on zonegroups.
+``hostnames`` in your zonegroup configuration. See :ref:`Ceph Object Gateway -
+Multisite Configuration <multisite>` for more on zonegroups.
 
 Here is an example of a ``ceph config set`` comamnd that sets ``rgw_dns_name``
 to ``cname.domain.com``:
@@ -135,5 +135,4 @@ Common Response Status
 | ``500``       | InternalError                     |
 +---------------+-----------------------------------+
 
-.. _`Ceph Object Gateway - Multisite Configuration`: ../../multisite
 .. _`Amazon S3 Path Deprecation Plan`: https://aws.amazon.com/blogs/aws/amazon-s3-path-deprecation-plan-the-rest-of-the-story/