]> git-server-git.apps.pok.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/radosgw: change all intra-docs links to use ref (6 of 6) 67010/head
authorVille Ojamo <14869000+bluikko@users.noreply.github.com>
Fri, 16 Jan 2026 09:55:15 +0000 (16:55 +0700)
committerVille Ojamo <14869000+bluikko@users.noreply.github.com>
Fri, 13 Feb 2026 05:42:49 +0000 (12:42 +0700)
Part 6 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 <git2233+ceph@ojamo.eu>
doc/radosgw/sync-modules.rst

index 2dc8330bfb6b1f9bc26b743b1b1c9e2c0e114416..4f6aa6b3b82eca66b663134c5608ea96c3ed1481 100644 (file)
@@ -17,11 +17,11 @@ tape drives, indexing metadata in ElasticSearch etc.
 
 A sync module configuration is local to a zone. The sync module determines
 whether the zone exports data or can only consume data that was modified in
-another zone. As of Luminous the supported sync plugins are `elasticsearch`_,
+another zone. As of Luminous the supported sync plugins are :ref:`elasticsearch <radosgw-elastic-sync-module>`,
 ``rgw``, which is the default sync plugin that synchronizes data between the
 zones and ``log`` which is a trivial sync plugin that logs the metadata
 operation that happens in the remote zones. The following docs are written with
-the example of a zone using `elasticsearch sync module`_, the process would be similar
+the example of a zone using :ref:`radosgw-elastic-sync-module`, the process would be similar
 for configuring any sync plugin.
 
 .. toctree::
@@ -71,7 +71,7 @@ For example in the ``elasticsearch`` sync module
                                --tier-config=endpoint=http://localhost:9200,num_shards=10,num_replicas=1
 
 
-For the various supported tier-config options refer to the `elasticsearch sync module`_ docs.
+For the various supported tier-config options refer to the :ref:`radosgw-elastic-sync-module` docs.
 
 Finally update the period
 
@@ -87,9 +87,3 @@ Now start the radosgw in the zone
    systemctl start ceph-radosgw@rgw.`hostname -s`
    systemctl enable ceph-radosgw@rgw.`hostname -s`
 
-
-
-.. _`elasticsearch sync module`: ../elastic-sync-module
-.. _`elasticsearch`: ../elastic-sync-module
-.. _`cloud sync module`: ../cloud-sync-module
-.. _`archive sync module`: ../archive-sync-module