X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=docs%2Findex.rst;h=bd23f1a0a4b29e3c2280385db9872d9333057d05;hb=8e510b50e3e47eafa880101eb224046e40171c98;hp=7d715147ec744d8be8cda1ae64bd2e346d12bfd8;hpb=5f800cee6c525f390df4d4cd3e76d7fa21502bb9;p=docs.git diff --git a/docs/index.rst b/docs/index.rst index 7d715147e..bd23f1a0a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,57 +6,61 @@ Welcome to OpenDaylight Documentation ===================================== -The following guides and documentation 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 documentation 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 + developer-guide/developing-apps-on-the-opendaylight-controller +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:`BGPCEP Documentation ` +* :doc:`COE Documentation ` +* :doc:`Controller Documentation ` +* :doc:`DAEXIM Documentation ` +* :doc:`Genius Documentation ` +* :doc:`Infrautils Documentation ` +* :doc:`LISP Flow Mapping Documentation ` +* :doc:`MD-SAL Documentation ` +* :doc:`NetConf Documentation ` +* :doc:`NetVirt Documentation ` +* :doc:`OpenFlowPlugin Documentation ` +* :doc:`OVSDB Documentation ` -.. toctree:: - :maxdepth: 1 +.. :doc:`Neutron Documentation ` - developer-guide/index - javadoc -Content for OpenDaylight Contributors -------------------------------------- +Self-Managed Projects +~~~~~~~~~~~~~~~~~~~~~ -The following content is intended for developers who either currently -participate in the development of OpenDaylight or would like to start. +* :doc:`JSON RPC Documentation ` +* :doc:`TransportPCE Documentation ` + +OpenDaylight Contributor Guides +------------------------------- * :doc:`Gerrit Guide ` * :ref:`Infrastructure Guide ` * :doc:`Integration Testing Guide ` -* :doc:`Integration Distribution Guide ` +* :doc:`Integration Distribution Guide ` * :doc:`Integration Packaging Guide ` - -.. toctree:: - :maxdepth: 1 - - documentation - release-process/index - +* :doc:`Release Process Guide ` +* :doc:`Documentation Guide ` +* :doc:`Javadocs ` .. Commenting the below out until we actually use it @@ -66,3 +70,14 @@ participate in the development of OpenDaylight or would like to start. .. * :ref:`genindex` .. * :ref:`modindex` .. * :ref:`search` + + +.. toctree:: + :maxdepth: 1 + :hidden: + + documentation + release-process/index + javadoc + user-guide/index + developer-guide/index