diff --git a/doc/index.rst b/doc/index.rst index 68d7c409241..d4ccd087afb 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.) `. +.. 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.) `. + .. container:: columns-3 .. container:: column diff --git a/doc/start/documenting-ceph.rst b/doc/start/documenting-ceph.rst index 6a392a47cc1..94fc8939ba4 100644 --- a/doc/start/documenting-ceph.rst +++ b/doc/start/documenting-ceph.rst @@ -1,3 +1,5 @@ +.. _documenting_ceph: + ================== Documenting Ceph ==================