From ac8ca243809392218d5a7b835fba9608b912c29d Mon Sep 17 00:00:00 2001 From: Zac Dover Date: Mon, 31 Jul 2023 19:27:29 +1000 Subject: [PATCH] doc/start: update linking conventions Update the "External Links" section of doc/start/documenting-ceph.rst. Signed-off-by: Zac Dover (cherry picked from commit 63750514d6ef7bf9dce6aa7c622664ea4310b59e) --- doc/start/documenting-ceph.rst | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/doc/start/documenting-ceph.rst b/doc/start/documenting-ceph.rst index f9b13452dc70a..e91d56234cf3d 100644 --- a/doc/start/documenting-ceph.rst +++ b/doc/start/documenting-ceph.rst @@ -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`. 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 ` 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`".