doc/radosgw: change all intra-docs links to use ref (4 of 6)

Part 4 of 6 to make backporting easier.

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>

diff --git a/doc/cephadm/services/index.rst b/doc/cephadm/services/index.rst
index d38d3555c2237550266ad48d14339f7721f4875e..d767a6baa0d59b5f7b00ad59aaef72e07788fd0e 100644 (file)
--- a/doc/cephadm/services/index.rst
+++ b/doc/cephadm/services/index.rst
@@ -638,6 +638,8 @@ false. Examples:
       - argument: "--annotation=com.example.note=a simple example"
 
 
+.. _cephadm-container-mount:
+
 Mounting Files with Extra Container Arguments
 ---------------------------------------------
 

diff --git a/doc/radosgw/d3n_datacache.rst b/doc/radosgw/d3n_datacache.rst
index d02395129fe04ae2e47ca39cbb0797ca0d9a628f..4c325e282101a30816a6aeb01f157425d97170ff 100644 (file)
--- a/doc/radosgw/d3n_datacache.rst
+++ b/doc/radosgw/d3n_datacache.rst
@@ -1,3 +1,5 @@
+.. _radosgw-d3n-datacache:
+
 ==================
 D3N RGW Data Cache
 ==================
@@ -42,7 +44,7 @@ Implementation
 
 - The D3N cache supports both the `S3` and `Swift` object storage interfaces.
 - D3N currently caches only tail objects, because they are immutable (by default it is parts of objects that are larger than 4MB).
-  (the NGINX `RGW Data cache and CDN`_ supports caching of all object sizes)
+  (the NGINX :ref:`radosgw-data-caching` supports caching of all object sizes)
 
 
 Requirements
@@ -92,7 +94,7 @@ In containerized deployments the cache directory should be mounted as a volume::
       - "-v"
       - "/mnt/nvme0/rgw_datacache/client.rgw.8000/:/mnt/nvme0/rgw_datacache/client.rgw.8000/"
 
-(Reference: `Service Management - Mounting Files with Extra Container Arguments`_)
+(Reference: :ref:`cephadm-container-mount`)
 
 If another RADOS Gateway is co-located on the same host, configure its persistent
 path to a discrete directory, for example in the case of ``client.rgw.8001``:
@@ -125,5 +127,3 @@ The following D3N related settings can be added to the Ceph configuration file
 
 .. _MOC D3N (Datacenter-scale Data Delivery Network): https://massopen.cloud/research-and-development/cloud-research/d3n/
 .. _Red Hat Research D3N Cache for Data Centers: https://research.redhat.com/blog/research_project/d3n-multilayer-cache/
-.. _RGW Data cache and CDN: ../rgw-cache/
-.. _Service Management - Mounting Files with Extra Container Arguments: ../cephadm/services/#mounting-files-with-extra-container-arguments

diff --git a/doc/radosgw/rgw-cache.rst b/doc/radosgw/rgw-cache.rst
index 9cfe8dd3a7303153f1c95277711058b261e92c5a..4f0bcdbe517492fbbd0ee73097e4fdea2e9cfa04 100644 (file)
--- a/doc/radosgw/rgw-cache.rst
+++ b/doc/radosgw/rgw-cache.rst
@@ -1,3 +1,5 @@
+.. _radosgw-data-caching:
+
 ========================
 RGW Data Caching and CDN
 ========================
@@ -17,7 +19,7 @@ and caching-out on subsequent GET requests, passing through transparently PUT,PO
 
 The feature introduces 2 new APIs: Auth and Cache.
 
-.. note:: The `D3N RGW Data Cache`_ is an alternative data caching mechanism implemented natively in the RADOS Gateway.
+.. note:: The :ref:`radosgw-d3n-datacache` is an alternative data caching mechanism implemented natively in the RADOS Gateway.
 
 New APIs
 --------
@@ -146,5 +148,3 @@ This can be done by commenting the following line in ``nginx-default.conf``:
 
  #auth_request /authentication;
 
-
-.. _D3N RGW Data Cache: ../d3n_datacache/