]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc: add link to "documenting ceph" to index.rst 51469/head
authorZac Dover <zac.dover@proton.me>
Fri, 21 Apr 2023 20:59:04 +0000 (22:59 +0200)
committerZac Dover <zac.dover@proton.me>
Sun, 14 May 2023 10:40:04 +0000 (20:40 +1000)
Add a link to the landing page of docs.ceph.com to direct documentation
contributors to documentation-related information.

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

doc/index.rst
doc/start/documenting-ceph.rst

index 68d7c409241c62bb09048b3bac00986b48d2fe98..d4ccd087afbac93d2ef804de471321328f1d63e7 100644 (file)
@@ -11,6 +11,12 @@ Ceph delivers **object, block, and file storage in one unified system**.
    Ceph project. (Click anywhere in this paragraph to read the "Basic 
    Workflow" page of the Ceph Developer Guide.) <basic workflow dev guide>`.
 
+.. note::
+
+   :ref:`If you want to make a commit to the documentation but you don't
+   know how to get started, read the "Documenting Ceph" page. (Click anywhere
+   in this paragraph to read the "Documenting Ceph" page.) <documenting_ceph>`.
+
 .. container:: columns-3
 
    .. container:: column
index 245b116463b3adeee06d32fe878a2b0932f6d0c0..f9b13452dc70ae2909d8e7ef7a3477b21a8c0410 100644 (file)
@@ -1,3 +1,5 @@
+.. _documenting_ceph:
+
 ==================
  Documenting Ceph
 ==================