]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/start: update linking conventions 52842/head
authorZac Dover <zac.dover@proton.me>
Mon, 31 Jul 2023 09:27:29 +0000 (19:27 +1000)
committerZac Dover <zac.dover@proton.me>
Sun, 6 Aug 2023 23:27:59 +0000 (09:27 +1000)
Update the "External Links" section of doc/start/documenting-ceph.rst.

Signed-off-by: Zac Dover <zac.dover@proton.me>
(cherry picked from commit 63750514d6ef7bf9dce6aa7c622664ea4310b59e)

doc/start/documenting-ceph.rst

index f86bad7bf6a5e6438079926dc6048bd269163890..3e088467525216809d97ffce5dc2b075fc4a9c3e 100644 (file)
@@ -981,7 +981,8 @@ External Links
 
 .. _external_link_with_inline_text:
 
-This is the formula for links to addresses external to the Ceph documentation:
+Use the formula immediately below to render links that direct the reader to
+addresses external to the Ceph documentation:
 
 ::
 
@@ -994,10 +995,13 @@ This is the formula for links to addresses external to the Ceph documentation:
 
    To link to addresses that are external to the Ceph documentation, include a
    space between the inline text and the angle bracket that precedes the
-   external address. This is precisely the opposite of :ref:`the convention for
-   inline text that links to a location inside the Ceph
-   documentation<internal_link_with_inline_text>`. If this seems inconsistent
-   and confusing to you, then you're right. It is inconsistent and confusing.
+   external address. This is precisely the opposite of the convention for
+   inline text that links to a location inside the Ceph documentation. See
+   :ref:`here <internal_link_with_inline_text>` for an exemplar of this
+   convention.
+
+   If this seems inconsistent and confusing to you, then you're right. It is
+   inconsistent and confusing.
 
 See also ":ref:`External Hyperlink Example<start_external_hyperlink_example>`".