]> git-server-git.apps.pok.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/radosgw: change all intra-docs links to use ref (2 of 6) 67006/head
authorVille Ojamo <14869000+bluikko@users.noreply.github.com>
Fri, 16 Jan 2026 09:43:31 +0000 (16:43 +0700)
committerVille Ojamo <14869000+bluikko@users.noreply.github.com>
Thu, 22 Jan 2026 05:43:40 +0000 (12:43 +0700)
Part 2 of 6 to make backporting easier. Depends on part 1.

Use the the ref role for all remaining links in doc/radosgw/ with the
exception of config-ref.rst which will depend on changes to rgw.yaml.in.

The external link definitions syntax being removed is intended for
linking to external websites and not for intra-docs links. Validity of
ref links will be checked during the docs build process.

Add labels for links targets if necessary.
Remove unused external link definitions in the modified files.

Use confval instead of literal text for 2 configuration keys in
vault.rst.

Signed-off-by: Ville Ojamo <14869000+bluikko@users.noreply.github.com>
doc/radosgw/account.rst

index 2c9f6cad379be3a5ac70480d8c7b41f7d6900a38..f0da3d7d08e16e3c5f223d1915419e375d1d9612 100644 (file)
@@ -8,7 +8,7 @@
 
 The Ceph Object Gateway supports *user accounts* as an optional feature to
 enable the self-service management of :ref:`Users <radosgw-user-management>`,
-Groups and `Roles`_ similar to those in `AWS Identity and Access Management`_
+Groups and :ref:`Roles <radosgw-role>` similar to those in `AWS Identity and Access Management`_
 (IAM).
 
 .. _radosgw-account-root-user:
@@ -22,7 +22,7 @@ accounts and account root users must be created by an administrator using
 
 The account root user has default permissions on all resources owned by
 the account. The root user's credentials (access and secret keys) can be
-used with the `Ceph Object Gateway IAM API`_ to create additional IAM users
+used with the :ref:`radosgw-iam` to create additional IAM users
 and roles for use with the :ref:`Ceph Object Gateway S3 API <radosgw s3>`, as
 well as to manage their associated access keys and policies.
 
@@ -198,7 +198,7 @@ Migrating Notification Topics
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Account topics are supported only when the ``notification_v2`` feature is enabled,
-as described in `Bucket Notifications`_ and `Supported Zone Features`_.
+as described in :ref:`radosgw-notifications` and :ref:`Supported Zone Features <radosgw-zone-features>`.
 
 #. **Migration Impact:** When a non-account user is migrated to an account, the
    the existing notification topics remain accessible through the RADOS Gateway admin API,
@@ -235,7 +235,7 @@ as described in `Bucket Notifications`_ and `Supported Zone Features`_.
 Account Root Example
 --------------------
 
-The account root user's credentials unlock the `Ceph Object Gateway IAM API`_.
+The account root user's credentials unlock the :ref:`radosgw-iam`.
 
 This example uses `awscli`_ to create an IAM user for S3 operations.
 
@@ -288,12 +288,8 @@ This example uses `awscli`_ to create an IAM user for S3 operations.
     make_bucket: testbucket
 
 
-.. _Roles: ../role/
 .. _AWS Identity and Access Management: https://aws.amazon.com/iam/
-.. _Ceph Object Gateway IAM API: ../iam/
 .. _Amazon Resource Names: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
 .. _Evaluating policies within a single account: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html#policy-eval-basics
 .. _Cross-account policy evaluation logic: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic-cross-account.html
 .. _awscli: https://docs.aws.amazon.com/cli/latest/
-.. _Bucket Notifications: ../notifications/
-.. _Supported Zone Features: ../zone-features/#supported-features