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`".