X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=docs%2Findex.rst;h=29f8077fbe4b2b7349942db421b989b86d0fa11a;hb=db59033f8eed5157b8f8471d10c03c2d472c3139;hp=6ae011fdcfb293636a3d0e89fa5c01ec7559efa1;hpb=1628809a665bdc559b218d3f3349caae29326dce;p=docs.git diff --git a/docs/index.rst b/docs/index.rst index 6ae011fdc..29f8077fb 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,35 +3,33 @@ 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 +Getting Started with OpenDaylight ------------------------------ -The following content is intended for people who would like to deploy, use, or -just learn more about OpenDaylight. - .. toctree:: :maxdepth: 1 + downloads release-notes/index getting-started-guide/index - user-guide/index - opendaylight-with-openstack/index +OpenDaylight User Guides +------------------------- -Content for OpenDaylight Developers ------------------------------------ +.. toctree:: + :maxdepth: 1 -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. + user-guide/index + +OpenDaylight Developer Guides +------------------------------ .. toctree:: :maxdepth: 1 @@ -40,26 +38,48 @@ itself. javadoc -Content for OpenDaylight Contributors -------------------------------------- +OpenDaylight Project Documentation +----------------------------------- -The following content is intended for developers who either currently -participate in the development of OpenDaylight or would like to start. +Managed Projects +~~~~~~~~~~~~~~~~~ + +* :doc:`AAA Documentation ` +* :doc:`../project-indexes/bgpcep-index` +* :doc:`Controller Documentation ` +* :doc:`COE Documentation ` +* :doc:`DAEXIM Documentation ` +* :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 ` + + +Self-Managed Projects +~~~~~~~~~~~~~~~~~~~~~~ + + +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 - submodules/genius/docs/index - submodules/infrautils/docs/index - submodules/netvirt/docs/contributor-guide/index - submodules/openflowplugin/docs/index - submodules/sfc/docs/index + + .. Commenting the below out until we actually use it .. Indices and tables