X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=docs%2Findex.rst;h=ee6a398110288eba65f95fc943a8d8f4b4c6f2a5;hb=21b2b2ffcaec453a5fc4118877c2c718a7b5ba39;hp=7b8504a6598deabc028ed61571e102787e744911;hpb=9af969ac0f6ef9f067ad5890300e3c24aa81e113;p=docs.git diff --git a/docs/index.rst b/docs/index.rst index 7b8504a65..ee6a39811 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,61 +3,68 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to the OpenDaylight Handbook! +Welcome to OpenDaylight Documentation ===================================== -This handbook provides details on various aspects of OpenDaylight from the user -guides to the developer guides and tries to act as a single point of contact -for all documentation related articles in OpenDaylight. If you would like to -contribute to the Handbook please refer to the :ref:`documentation-guide`. +The OpenDaylight documentation site acts as a central clearinghouse for +OpenDaylight project and release documentation. If you would like to contribute +to documentation, refer to the :ref:`documentation-guide`. -Content for OpenDaylight Users ------------------------------- - -The following content is intended for people who would like to deploy, use, or -just learn more about OpenDaylight. +Getting Started with OpenDaylight +--------------------------------- .. toctree:: :maxdepth: 1 + downloads release-notes/index getting-started-guide/index - user-guide/index - opendaylight-with-openstack/index +OpenDaylight Project Documentation +---------------------------------- -Content for OpenDaylight Developers ------------------------------------ +Managed Projects +~~~~~~~~~~~~~~~~ -The Following content is intended for developers building applications or code -on top of OpenDaylight, but who do not plan to modify OpenDaylight code -itself. +.. :doc:`AAA Documentation ` +.. :doc:`Controller Documentation ` +.. :doc:`NETCONF Documentation ` +.. :doc:`Neutron Documentation ` -.. toctree:: - :maxdepth: 1 +* :doc:`../project-indexes/bgpcep-index` +* :doc:`COE Documentation ` +* :doc:`../project-indexes/daexim-index` +* :doc:`Genius Documentation ` +* :doc:`Infrautils Documentation ` +* :doc:`../project-indexes/lispflowmapping-index` +* :doc:`MD-SAL Documentation ` +* :doc:`NetVirt Documentation ` +* :doc:`OpenFlowPlugin Documentation ` +* :doc:`OVSDB Documentation ` - developer-guide/index +Self-Managed Projects +~~~~~~~~~~~~~~~~~~~~~ + +* :doc:`../project-indexes/sxp-index` -Content for OpenDaylight Contributors -------------------------------------- -The following content is intended for developers who either currently -participate in the development of OpenDaylight or would like to start. +OpenDaylight Contributor Guides +------------------------------- + +* :doc:`Gerrit Guide ` +* :ref:`Infrastructure Guide ` +* :doc:`Integration Testing Guide ` +* :doc:`Integration Distribution Guide ` +* :doc:`Integration Packaging Guide ` .. toctree:: :maxdepth: 1 - gerrit - submodules/releng/builder/docs/index - submodules/integration/test/docs/index documentation release-process/index - submodules/spectrometer/docs/index javadoc - submodules/genius/docs/index - submodules/infrautils/docs/index - submodules/netvirt/docs/contributor-guide/index + developer-guide/index .. Commenting the below out until we actually use it .. Indices and tables @@ -66,3 +73,18 @@ participate in the development of OpenDaylight or would like to start. .. * :ref:`genindex` .. * :ref:`modindex` .. * :ref:`search` + + +.. toctree:: + :maxdepth: 1 + :hidden: + + developer-guide/index + + opendaylight-with-openstack/index + release-notes/sample-release-notes + user-guide/index + project-indexes/bgpcep-index + project-indexes/daexim-index + project-indexes/lispflowmapping-index + project-indexes/sxp-index