]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/start: add Anthony D'Atri's suggestions 49616/head
authorZac Dover <zac.dover@gmail.com>
Mon, 2 Jan 2023 13:00:55 +0000 (23:00 +1000)
committerZac Dover <zac.dover@gmail.com>
Tue, 3 Jan 2023 07:53:53 +0000 (17:53 +1000)
Add the suggestions made by Anthony D'Atri in
https://github.com/ceph/ceph/pull/49609.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
(cherry picked from commit 6141c5f0618432b5dc23d53b5920cab48aa5db7e)

doc/start/documenting-ceph.rst

index d0f818efcad1b1d8c71c0f2680b3f3bb69b63b7b..93b266d1630c277d436c64806469b45b15465685 100644 (file)
@@ -734,10 +734,10 @@ This is the formula for links to addresses external to the Ceph documentation:
    
    Do not fail to include the underscore after the final backtick.
 
-   To link to addresses that are external to the Ceph documentation, you have
-   to 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
+   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.
 
@@ -746,10 +746,10 @@ See also ":ref:`External Hyperlink Example<start_external_hyperlink_example>`".
 Internal Links
 ~~~~~~~~~~~~~~
 
-To link to a section that is in the Ceph documentation, you must (1) define a
-target link before the section and then (2) link to that target from another
-location in the documentation. Here are the formulas for targets and links to
-those targets:
+To link to a section in the Ceph documentation, you must (1) define a target
+link before the section and then (2) link to that target from another location
+in the documentation. Here are the formulas for targets and links to those
+targets:
 
 Target::