X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=docs%2Findex.rst;h=097f9f46af3d8aea6ee3c54e27f2065ff77193dc;hb=b4844a4250384aec440de77394aabba462eece9b;hp=83fca7faa0626a95af38dcdbb50497dce1f52d53;hpb=a3d4cb84d1961030741e2a313e786c36b8ab65a1;p=docs.git diff --git a/docs/index.rst b/docs/index.rst index 83fca7faa..097f9f46a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,56 +3,66 @@ 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:`../project-indexes/bgpcep-index` +* :doc:`Controller Documentation ` +* :doc:`COE Documentation ` +* :doc:`../project-indexes/daexim-index` +* :doc:`Genius Documentation ` +* :doc:`Infrautils Documentation ` +* :doc:`../project-indexes/lispflowmapping-index` +* :doc:`MD-SAL Documentation ` +* :doc:`NETCONF Documentation ` +* :doc:`NetVirt Documentation ` +* :doc:`Neutron Documentation ` +* :doc:`OpenFlowPlugin Documentation ` +* :doc:`OVSDB Documentation ` -.. toctree:: - :maxdepth: 1 - developer-guide/index - javadoc +Self-Managed Projects +~~~~~~~~~~~~~~~~~~~~~ -Content for OpenDaylight Contributors -------------------------------------- +* :doc:`../project-indexes/sxp-index` -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 ` -* documentation -* release-process/index +.. toctree:: + :maxdepth: 1 + documentation + release-process/index + javadoc .. Commenting the below out until we actually use it .. Indices and tables