From: Nathan Cutler Date: Thu, 26 Jul 2018 04:21:04 +0000 (+0200) Subject: doc: make it easier to reach the old dev doc TOC X-Git-Tag: v14.0.1~758^2~1 X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=ef3ac5692b7eb79ec93537b612100ce3ed7f767b;p=ceph.git doc: make it easier to reach the old dev doc TOC Signed-off-by: Nathan Cutler --- diff --git a/doc/dev/index-old.rst b/doc/dev/index-old.rst deleted file mode 100644 index 8192516b65e..00000000000 --- a/doc/dev/index-old.rst +++ /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* diff --git a/doc/dev/index.rst b/doc/dev/index.rst index 9da086f3629..bc6a119796f 100644 --- a/doc/dev/index.rst +++ b/doc/dev/index.rst @@ -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 index 00000000000..20295c0f5d5 --- /dev/null +++ b/doc/dev/internals.rst @@ -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* diff --git a/doc/index.rst b/doc/index.rst index 84490aeb983..7da74fb7252 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -102,7 +102,8 @@ about Ceph, see our `Architecture`_ section. mgr/index api/index architecture - Development + Developer Guide + dev/internals governance ceph-volume/index releases/index