doc: Convert the mailing list mention to not be a section heading.

If toctree is inside a section, the subtree is inside the section too.
We don't want all of dev/* to be under "Mailing list".

I have not found a decent workaround for this. The toplevel toctree
avoids this purely by the fact that it is the topmost toctree. Right
now that means you should 1) avoid having more than a few paragraphs of
text before the toctree for that subtree (put most of the content after
the toctree; clumsy if the toctree is long), or 2) put the toptree
immediately after the document title, make it :hidden:, and let the
reader use links in the text or the ToC in the sidebar to navigate.
See start/index for an example of this.

Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>

diff --git a/doc/dev/index.rst b/doc/dev/index.rst
index 628b958ae3fbd7a0018e4f25aff01156651c56c5..0c752fb54f4b41befa72d00ea55087379bab1f4c 100644 (file)
--- a/doc/dev/index.rst
+++ b/doc/dev/index.rst
@@ -18,8 +18,7 @@ You can start a development mode Ceph cluster, after compiling the source, with:
 
 .. _mailing-list:
 
-Mailing list
-============
+.. rubric:: Mailing list
 
 The official development email list is ``ceph-devel@vger.kernel.org``.  Subscribe by sending
 a message to ``majordomo@vger.kernel.org`` with the line::
@@ -28,6 +27,9 @@ a message to ``majordomo@vger.kernel.org`` with the line::
 
 in the body of the message.
 
+
+.. rubric:: Contents
+
 .. toctree::
    :glob:
 

diff --git a/doc/ops/manage/failures/osd.rst b/doc/ops/manage/failures/osd.rst
index 4d2196406af13bdaf57c04c72222c6d70050f42a..fe98c2855874b999666e7ae88073d7480855ca18 100644 (file)
--- a/doc/ops/manage/failures/osd.rst
+++ b/doc/ops/manage/failures/osd.rst
@@ -31,7 +31,8 @@ kernel file system may unresponsive; check ``dmesg`` output for disk
 or other kernel errors.
 
 If the problem is a software error (failed assertion or other
-unexpected error), it should be reported to the :ref:`mailing-list`.
+unexpected error), it should be reported to the :ref:`mailing list
+<mailing-list>`.
 
 
 Full cluster