X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=docs%2Findex.rst;h=1e53075e2ca9ca3af326621c05833713ac884a62;hb=refs%2Fchanges%2F50%2F88550%2F1;hp=227f5e1c4b62c00e381153f51dd0f2d8fcce975e;hpb=4233f69ec49c3f919cc25559d1d34d3bb5529237;p=docs.git diff --git a/docs/index.rst b/docs/index.rst index 227f5e1c4..1e53075e2 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,62 +3,65 @@ 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 + 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:`JSON RPC 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 +Self-Managed Projects +~~~~~~~~~~~~~~~~~~~~~ -Content for OpenDaylight Contributors -------------------------------------- +* :doc:`TransportPCE Documentation ` -The following content is intended for developers who either currently -participate in the development of OpenDaylight or would like to start. +OpenDaylight Contributor Guides +------------------------------- -.. toctree:: - :maxdepth: 1 +* :doc:`Gerrit Guide ` +* :ref:`Infrastructure Guide ` +* :doc:`Integration Testing Guide ` +* :doc:`Integration Distribution Guide ` +* :doc:`Integration Packaging Guide ` +* :doc:`Release Process Guide ` +* :doc:`Documentation Guide ` +* :doc:`Javadocs ` - gerrit - submodules/releng/builder/docs/index - submodules/integration/test/docs/index - documentation - release-process/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 @@ -67,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