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 <aaa:index>`
+* :doc:`BGPCEP Documentation <bgpcep:index>`
+* :doc:`COE Documentation <coe:index>`
+* :doc:`Controller Documentation <controller:index>`
+* :doc:`DAEXIM Documentation <daexim:index>`
+* :doc:`Genius Documentation <genius:index>`
+* :doc:`Infrautils Documentation <infrautils:index>`
+* :doc:`LISP Flow Mapping Documentation <lispflowmapping:index>`
+* :doc:`MD-SAL Documentation <mdsal:index>`
+* :doc:`NetConf Documentation <netconf:index>`
+* :doc:`NetVirt Documentation <netvirt:index>`
+* :doc:`OpenFlowPlugin Documentation <openflowplugin:index>`
+* :doc:`OVSDB Documentation <ovsdb:index>`
-.. toctree::
- :maxdepth: 1
+.. :doc:`Neutron Documentation <neutron:index>`
- developer-guide/index
- javadoc
+Self-Managed Projects
+~~~~~~~~~~~~~~~~~~~~~
-Content for OpenDaylight Contributors
--------------------------------------
+* :doc:`SXP Documentation <sxp:index>`
-The following content is intended for developers who either currently
-participate in the development of OpenDaylight or would like to start.
-.. toctree::
- :maxdepth: 1
+OpenDaylight Contributor Guides
+-------------------------------
+
+* :doc:`Gerrit Guide <lfdocs:gerrit>`
+* :ref:`Infrastructure Guide <odl-infra>`
+* :doc:`Integration Testing Guide <odl-integration-test:index>`
+* :doc:`Integration Distribution Guide <odl-integration-distribution:index>`
+* :doc:`Integration Packaging Guide <odl-integration-packaging:index>`
+* :doc:`Release Process Guide <release-process/index>`
+* :doc:`Documentation Guide <documentation>`
+* :doc:`Javadocs <javadoc>`
- 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
.. Commenting the below out until we actually use it
.. Indices and tables
.. * :ref:`genindex`
.. * :ref:`modindex`
.. * :ref:`search`
+
+
+.. toctree::
+ :maxdepth: 1
+ :hidden:
+
+ documentation
+ release-process/index
+ javadoc
+ opendaylight-with-openstack/index
+ release-notes/sample-release-notes
+ user-guide/index
+ developer-guide/index
Code Review / docs.git / blobdiff