]> git-server-git.apps.pok.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/index.rst: add link to Dev Guide basic workfl. 46894/head
authorZac Dover <zac.dover@gmail.com>
Wed, 29 Jun 2022 12:57:13 +0000 (22:57 +1000)
committerZac Dover <zac.dover@gmail.com>
Wed, 29 Jun 2022 12:57:13 +0000 (22:57 +1000)
This PR adds a link to the "Basic Workflow" section of the
Developer Guide on the landing page of docs.ceph.com.

This PR is meant to improve the documentation for developers
new to Ceph and to guide them to instructions that will allow
them to become full-fledged contributors to the Ceph project
as quickly as possible.

The "Basic Workflow" page of the Developer Guide contains
information that answers almost all of the questions that I had
about contributing to the Ceph project when I was new to it,
and I am finally acting on my long-held conviction that the
"Basic Workflow" page of the Developer Guide should have a more
prominent position in the documentation suite than it has had.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
doc/dev/developer_guide/basic-workflow.rst
doc/index.rst

index 63eada9efd04b53fe2bb7a5f7a4739ee65e76556..60e0ecb3f86f68dd86e8aac887d9873326aba067 100644 (file)
@@ -1,3 +1,5 @@
+.. _basic workflow dev guide:
+
 Basic Workflow
 ==============
 
index cca7031cb8db9a6096d2f9eb9393b404b62fed87..b9323c452648e5b6f4775a9f6bb0c62eaf68c3e9 100644 (file)
@@ -5,6 +5,13 @@
 Ceph uniquely delivers **object, block, and file storage in one unified
 system**.
 
+.. warning:: 
+
+   :ref:`If this is your first time using Ceph, read the "Basic Workflow" 
+   page in the Ceph Developer Guide to learn how to contribute to the 
+   Ceph project. (Click anywhere in this paragraph to read the "Basic 
+   Workflow" page of the Ceph Developer Guide.) <basic workflow dev guide>`.
+
 .. container:: columns-3
 
    .. container:: column