From c624a2a8ef71035eef34ee866ef7668f83a139e7 Mon Sep 17 00:00:00 2001 From: Zac Dover Date: Wed, 29 Jun 2022 22:57:13 +1000 Subject: [PATCH] doc/index.rst: add link to Dev Guide basic workfl. 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 --- doc/dev/developer_guide/basic-workflow.rst | 2 ++ doc/index.rst | 7 +++++++ 2 files changed, 9 insertions(+) diff --git a/doc/dev/developer_guide/basic-workflow.rst b/doc/dev/developer_guide/basic-workflow.rst index 63eada9efd0..60e0ecb3f86 100644 --- a/doc/dev/developer_guide/basic-workflow.rst +++ b/doc/dev/developer_guide/basic-workflow.rst @@ -1,3 +1,5 @@ +.. _basic workflow dev guide: + Basic Workflow ============== diff --git a/doc/index.rst b/doc/index.rst index cca7031cb8d..b9323c45264 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -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.) `. + .. container:: columns-3 .. container:: column -- 2.39.5