From 91f773805268403825a2efa88ea03bf49312c1c1 Mon Sep 17 00:00:00 2001 From: Zac Dover Date: Fri, 21 Apr 2023 22:59:04 +0200 Subject: [PATCH] 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 (cherry picked from commit 155a382cb2e8b80dca260ca7abdc3cc89c805edb) --- doc/index.rst | 6 ++++++ doc/start/documenting-ceph.rst | 2 ++ 2 files changed, 8 insertions(+) diff --git a/doc/index.rst b/doc/index.rst index 68d7c409241c6..d4ccd087afbac 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 245b116463b3a..f9b13452dc70a 100644 --- a/doc/start/documenting-ceph.rst +++ b/doc/start/documenting-ceph.rst @@ -1,3 +1,5 @@ +.. _documenting_ceph: + ================== Documenting Ceph ================== -- 2.39.5