]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc: make it easier to reach the old dev doc TOC
authorNathan Cutler <ncutler@suse.com>
Thu, 26 Jul 2018 04:21:04 +0000 (06:21 +0200)
committerNathan Cutler <ncutler@suse.com>
Thu, 26 Jul 2018 08:49:11 +0000 (10:49 +0200)
Signed-off-by: Nathan Cutler <ncutler@suse.com>
doc/dev/index-old.rst [deleted file]
doc/dev/index.rst
doc/dev/internals.rst [new file with mode: 0644]
doc/index.rst

diff --git a/doc/dev/index-old.rst b/doc/dev/index-old.rst
deleted file mode 100644 (file)
index 8192516..0000000
+++ /dev/null
@@ -1,42 +0,0 @@
-:orphan:
-
-==================================
- Internal developer documentation
-==================================
-
-.. note:: If you're looking for how to use Ceph as a library from your
-   own software, please see :doc:`/api/index`.
-
-You can start a development mode Ceph cluster, after compiling the source, with::
-
-       cd src
-       install -d -m0755 out dev/osd0
-       ./vstart.sh -n -x -l
-       # check that it's there
-       ./ceph health
-
-.. todo:: vstart is woefully undocumented and full of sharp sticks to poke yourself with.
-
-
-.. _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::
-
- subscribe ceph-devel
-
-in the body of the message.
-
-
-.. rubric:: Contents
-
-.. toctree::
-   :glob:
-
-   *
-   osd_internals/index*
-   mds_internals/index*
-   radosgw/index*
-   ceph-volume/index*
index 9da086f362970fbef5a500b38cff9f0eaa5037d1..bc6a119796f27404ff96b7557501b1fd85785fd1 100644 (file)
@@ -6,7 +6,7 @@ Contributing to Ceph: A Guide for Developers
 :Author: Nathan Cutler
 :License: Creative Commons Attribution Share Alike 3.0 (CC-BY-SA-3.0)
 
-.. note:: The old (pre-2016) developer documentation has been moved to :doc:`/dev/index-old`.
+.. note:: You may also be interested in the :doc:`/dev/internals` documentation.
 
 .. contents::
    :depth: 3
diff --git a/doc/dev/internals.rst b/doc/dev/internals.rst
new file mode 100644 (file)
index 0000000..20295c0
--- /dev/null
@@ -0,0 +1,42 @@
+:orphan:
+
+================
+ Ceph Internals
+================
+
+.. note:: If you're looking for how to use Ceph as a library from your
+   own software, please see :doc:`/api/index`.
+
+You can start a development mode Ceph cluster, after compiling the source, with::
+
+       cd src
+       install -d -m0755 out dev/osd0
+       ./vstart.sh -n -x -l
+       # check that it's there
+       ./ceph health
+
+.. todo:: vstart is woefully undocumented and full of sharp sticks to poke yourself with.
+
+
+.. _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::
+
+ subscribe ceph-devel
+
+in the body of the message.
+
+
+.. rubric:: Contents
+
+.. toctree::
+   :glob:
+
+   *
+   osd_internals/index*
+   mds_internals/index*
+   radosgw/index*
+   ceph-volume/index*
index 84490aeb983732101a3631e063008487e49a6b37..7da74fb7252ea50c608aa866f23c9b8de876ea40 100644 (file)
@@ -102,7 +102,8 @@ about Ceph, see our `Architecture`_ section.
    mgr/index
    api/index
    architecture
-   Development <dev/index>
+   Developer Guide <dev/index>
+   dev/internals
    governance
    ceph-volume/index
    releases/index