doc/radosgw: Use ref for hyperlinks, 1st batch

Use validated ":ref:" hyperlinks instead of "external links" in "target
definitions" when linking within the Ceph docs:
- Add a label at beginning of referenced files if missing.
- Remove unused "target definitions".

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>

diff --git a/doc/radosgw/account.rst b/doc/radosgw/account.rst
index 0e4ede5a50a793ba227d8cdc751aa2564d142514..6b1867a5dbfd7b80a96392bf7d56f051696a6518 100644 (file)
--- a/doc/radosgw/account.rst
+++ b/doc/radosgw/account.rst
@@ -1,3 +1,5 @@
+.. _radosgw-account:
+
 ===============
  User Accounts
 ===============

diff --git a/doc/radosgw/admin.rst b/doc/radosgw/admin.rst
index 5c52aef6d5d4e89cc1eba62c1fab4808ca4681fd..e580409f80c3f7f8add7a462533cd58e152e2bf5 100644 (file)
--- a/doc/radosgw/admin.rst
+++ b/doc/radosgw/admin.rst
@@ -14,7 +14,7 @@ Ceph Object Storage user management refers only to users of the Ceph Object
 Storage service and not to the Ceph Object Gateway as a user of the Ceph
 Storage Cluster. Create a user, access key, and secret key to enable end users
 to interact with Ceph Object Gateway services. Optionally, the users can belong
-to `Accounts`_ for ease of management.
+to :ref:`Accounts <radosgw-account>` for ease of management.
 
 There are two types of user: 
 
@@ -364,7 +364,7 @@ To remove a Swift secret key, run a command of the following form:
 Add or Remove Admin Capabilities
 --------------------------------
 
-The Ceph Storage Cluster provides an `Admin Ops API`_ that enables users to
+The Ceph Storage Cluster provides an :ref:`Admin Ops API <radosgw admin ops>` that enables users to
 execute administrative functions via the REST API. By default, users do NOT
 have access to this API. To enable a user to exercise administrative
 functionality, provide the user with administrative capabilities.
@@ -404,7 +404,7 @@ Users with the ``--admin`` or ``--system`` flag have global read and write
 permissions. These permissions apply to all APIs including S3 and Swift,
 unlike Admin Capabilities, and cannot be denied by IAM policy.
 
-The ``--system`` flag should only be used as documented in `Multisite Configuration`_.
+The ``--system`` flag should only be used as documented in :ref:`Multisite Configuration <multisite>`.
 
 The ``--admin`` flag can be useful for troubleshooting and recovery. For
 example, if a user accidentally removes their permissions to a bucket or
@@ -572,8 +572,7 @@ quota is set for all subsequently-created users, and that quota is enabled. See
 ``rgw_bucket_default_quota_max_objects``,
 ``rgw_bucket_default_quota_max_size``, ``rgw_user_default_quota_max_objects``,
 ``rgw_user_default_quota_max_size``, ``rgw_account_default_quota_max_objects``,
-and ``rgw_account_default_quota_max_size`` in `Ceph Object Gateway Config
-Reference`_.
+and ``rgw_account_default_quota_max_size`` in :ref:`radosgw-config-ref`.
 
 Quota Cache
 -----------
@@ -595,7 +594,7 @@ the multiple RGW instances closer to perfect quota synchronization.
 
 If all three values are set to ``0`` , then quota caching is effectively
 disabled, and multiple instances will have perfect quota enforcement.  See
-`Ceph Object Gateway Config Reference`_.
+:ref:`radosgw-config-ref`.
 
 Reading / Writing Global Quotas
 -------------------------------
@@ -929,10 +928,3 @@ example commands:
    radosgw-admin usage trim --uid=johndoe      
    radosgw-admin usage trim --uid=johndoe --end-date=2013-12-31
 
-
-.. _radosgw-admin: ../../man/8/radosgw-admin/
-.. _Pool Configuration: ../../rados/configuration/pool-pg-config-ref/
-.. _Ceph Object Gateway Config Reference: ../config-ref/
-.. _Accounts: ../account/
-.. _Admin Ops API: ../adminops/
-.. _Multisite Configuration: ../multisite/

diff --git a/doc/radosgw/cloud-transition.rst b/doc/radosgw/cloud-transition.rst
index 2858b588254d3870390ed40f39f4a390010e5753..d1dac9652a13b198373c7852b10edd750adcdf4c 100644 (file)
--- a/doc/radosgw/cloud-transition.rst
+++ b/doc/radosgw/cloud-transition.rst
@@ -147,7 +147,7 @@ How to Configure
 
 See :ref:`adding_a_storage_class` for how to configure storage-class for a zonegroup. The cloud transition requires a creation of a special storage class with tier type defined as ``cloud-s3`` or ``cloud-s3-glacier``
 
-.. note:: If you have not performed previous `Multisite Configuration`_,
+.. note:: If you have not performed 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 (RGW daemons) are restarted. If you have created a realm for multisite,
@@ -426,5 +426,3 @@ Future Work
 * Support s3:RestoreObject operation on cloud transitioned objects.
 
 * Support transition to other cloud providers (like Azure).
-
-.. _`Multisite Configuration`: ../multisite

diff --git a/doc/radosgw/config-ref.rst b/doc/radosgw/config-ref.rst
index 97a674a6e9ebefff813e7751d8b70777425063f1..053dbd9cbfa338f136bc661e63e29bff7a3f7ebe 100644 (file)
--- a/doc/radosgw/config-ref.rst
+++ b/doc/radosgw/config-ref.rst
@@ -1,3 +1,5 @@
+.. _radosgw-config-ref:
+
 ======================================
  Ceph Object Gateway Config Reference
 ======================================

diff --git a/doc/radosgw/frontends.rst b/doc/radosgw/frontends.rst
index 890d0d889f6d01a8bee7d8f4e799d0798c019113..cec1daf1de0658678530ad3ad8429cf2b5194f0c 100644 (file)
--- a/doc/radosgw/frontends.rst
+++ b/doc/radosgw/frontends.rst
@@ -7,7 +7,7 @@ HTTP Frontends
 .. contents::
 
 The Ceph Object Gateway supports two embedded HTTP frontend libraries
-that can be configured with ``rgw_frontends``. See `Config Reference`_
+that can be configured with ``rgw_frontends``. See :ref:`radosgw-config-ref`
 for details about the syntax.
 
 Beast
@@ -161,5 +161,3 @@ Some frontend options are generic and supported by all frontends:
 :Type: String
 :Default: None
 
-
-.. _Config Reference: ../config-ref