]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc: add link to "documenting ceph" to index.rst 51471/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:49:24 +0000 (20:49 +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 98c1be894f5fc0195d904ebe45d8334d4aeec204..bda03d8ede21255727513dbf18ca6383967b59e3 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>`.
+
 .. raw:: html
 
       <style type="text/css">div.body h3{margin:5px 0px 0px 0px;}</style>
index 3158f8a6ad5865dec21cab5cc7268ec9e5602fac..d6839f60a4622e02045002e262fa31bb9d333dce 100644 (file)
@@ -1,3 +1,5 @@
+.. _documenting_ceph:
+
 ==================
  Documenting Ceph
 ==================