diff options
| author | Zac Dover <zac.dover@gmail.com> | 2022-06-29 14:57:13 +0200 |
|---|---|---|
| committer | Zac Dover <zac.dover@gmail.com> | 2022-06-29 14:57:13 +0200 |
| commit | c624a2a8ef71035eef34ee866ef7668f83a139e7 (patch) | |
| tree | fb7ecdd25a2ae9484265b73e1f5980bb76486938 /doc/index.rst | |
| parent | Merge pull request #46864 from rzarzynski/wip-crimson-gcc11 (diff) | |
| download | ceph-c624a2a8ef71035eef34ee866ef7668f83a139e7.tar.xz ceph-c624a2a8ef71035eef34ee866ef7668f83a139e7.zip | |
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 <zac.dover@gmail.com>
Diffstat (limited to 'doc/index.rst')
| -rw-r--r-- | doc/index.rst | 7 |
1 files changed, 7 insertions, 0 deletions
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.) <basic workflow dev guide>`. + .. container:: columns-3 .. container:: column |