Add index with submodules 15/26415/5
authorShubhamRathi <shubhamiiitbackup@gmail.com>
Thu, 22 Dec 2016 06:47:04 +0000 (12:17 +0530)
committerShubhamRathi <shubhamiiitbackup@gmail.com>
Sat, 14 Jan 2017 10:16:47 +0000 (15:46 +0530)
Index page updated to point to feature, testing and installer
projects. This is in tandem with the plan to divide documentation in
Release, Developer and Testing.

Change-Id: I7e54190d402a6c241a358c9e13ce477d496f23a3
Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
docs/index.rst

index 4923d70..98ee19f 100644 (file)
@@ -1,47 +1,50 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-.. (c) Ericsson AB
+OPNFV Documentation
+===================
 
-***********************************
-OPNFV Docs placeholder landing page
-***********************************
+Open Platform for NFV (OPNFV) facilitates the development and evolution
+of NFV components across various open source ecosystems. Through
+system level integration, deployment and testing, OPNFV creates a
+reference NFV platform to accelerate the transformation of enterprise
+and service provider networks. Participation is open to anyone,
+whether you are an employee of a member company or just passionate
+about network transformation.
 
-This will be extended to include all the sub pages and to provide the docs.opnfv.org landing page for Danube.
-
-=====================
 Release Documentation
-=====================
-
-Just pointing to the index.rst file here, but we need to break that out and have
-sub-directories for each of the projects documents to be copied into.
+----------------------
 
 .. toctree::
    :maxdepth: 1
 
-   release/index
-
-.. need to figure out the correct URL to use here so readthedocs does it for us.
+   release/overview
+   release/installation.introduction
+   release/userguide.introduction
+   release/subrelease
 
-=======
-Testing
-=======
 
-Just pointing to the index.rst file here, but we need to break that out and have
-sub-directories for each of the projects documents to be copied into.
+Developer Documentation
+-----------------------------------
 
 .. toctree::
    :maxdepth: 1
 
-   testing/index
+   featureprojects
 
-=========
-Developer
-=========
 
-Just pointing to the index.rst file here, but we need to break that out and have
-sub-directories for each of the projects documents to be copied into.
+Testing Documentation
+-------------------------------------
 
 .. toctree::
    :maxdepth: 1
 
-   developer/index
\ No newline at end of file
+   submodules/functest/docs/userguide/index
+   submodules/bottlenecks/docs/userguide/index
+   submodules/yardstick/docs/userguide/index
+   submodules/vswitchperf/docs/index
+
+.. Commenting the below out until we actually use it
+.. Indices and tables
+.. ==================
+..
+.. * :ref:`genindex`
+.. * :ref:`modindex`
+.. * :ref:`search`
\ No newline at end of file