From: Zac Dover <zac.dover@proton.me>
Date: Fri, 21 Apr 2023 20:59:04 +0000 (+0200)
Subject: doc: add link to "documenting ceph" to index.rst
X-Git-Tag: v16.2.14~143^2
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=refs%2Fpull%2F51471%2Fhead;p=ceph.git

doc: add link to "documenting ceph" to index.rst

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)
---

diff --git a/doc/index.rst b/doc/index.rst
index 98c1be894f5f..bda03d8ede21 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -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>
diff --git a/doc/start/documenting-ceph.rst b/doc/start/documenting-ceph.rst
index 3158f8a6ad58..d6839f60a462 100644
--- a/doc/start/documenting-ceph.rst
+++ b/doc/start/documenting-ceph.rst
@@ -1,3 +1,5 @@
+.. _documenting_ceph:
+
 ==================
  Documenting Ceph
 ==================