X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=docs%2Findex.rst;h=594b3cb94f3012739259a477f9fb6b7a77947aac;hb=561739d440ec7b30e718a89ab9221b65519681ed;hp=4f5956124908998f4704781783270585ffabc7f3;hpb=5569f9ec5009b22e91f5b1cebc96ddbd0bfda76f;p=docs.git diff --git a/docs/index.rst b/docs/index.rst index 4f5956124..594b3cb94 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,65 +3,63 @@ 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-guides/index +Contributing to OpenDaylight +---------------------------- -Content for OpenDaylight Developers ------------------------------------ +* :doc:`Contributor Guides ` +* :ref:`Infrastructure Guide ` +* :doc:`Integration Testing Guide ` +* :doc:`Integration Distribution Guide ` +* :doc:`Integration Packaging Guide ` +* :doc:`Release Process Guide ` +* :doc:`Documentation Guide ` +* :doc:`Javadocs ` -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. +OpenDaylight Project Documentation +---------------------------------- -.. toctree:: - :maxdepth: 1 +Managed Projects +~~~~~~~~~~~~~~~~ - developer-guide/index - javadoc +* :doc:`AAA Documentation ` +* :doc:`BGPCEP Documentation ` +* :doc:`Controller Documentation ` +* :doc:`DAEXIM Documentation ` +* :doc:`Infrautils Documentation ` +* :doc:`JSON RPC Documentation ` +* :doc:`LISP Flow Mapping Documentation ` +* :doc:`MD-SAL Documentation ` +* :doc:`NetConf Documentation ` +* :doc:`OpenFlowPlugin Documentation ` +* :doc:`OVSDB Documentation ` +.. :doc:`Neutron Documentation ` -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. +Self-Managed Projects +~~~~~~~~~~~~~~~~~~~~~ -* :doc:`Gerrit Guide ` -* :ref:`Infrastructure Guide ` -* :doc:`Integration Testing Guide ` -* :doc:`Integration Packaging Guide ` +* :doc:`Genius Documentation ` +* :doc:`TransportPCE Documentation ` -.. toctree:: - :maxdepth: 1 - - submodules/releng/builder/docs/index - documentation - release-process/index - submodules/genius/docs/index - submodules/infrautils/docs/index - submodules/netvirt/docs/index - submodules/openflowplugin/docs/index - submodules/sfc/docs/index .. Commenting the below out until we actually use it .. Indices and tables @@ -70,3 +68,15 @@ 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-guides/index + contributor-guides/index