Skip to content

Commit

Permalink
doc/start: update linking conventions
Browse files Browse the repository at this point in the history
Update the "External Links" section of doc/start/documenting-ceph.rst.

Signed-off-by: Zac Dover <zac.dover@proton.me>
(cherry picked from commit 6375051)
  • Loading branch information
zdover23 committed Aug 6, 2023
1 parent da5ad87 commit ac8ca24
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions doc/start/documenting-ceph.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

::

Expand All @@ -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>`".

Expand Down

0 comments on commit ac8ca24

Please sign in to comment.