diff options
| author |   ShubhamRathi <shubhamiiitbackup@gmail.com> | 2016-12-22 12:17:04 +0530 |
|---|---|---|
| committer | ShubhamRathi <shubhamiiitbackup@gmail.com> | 2017-01-14 15:46:47 +0530 |
| commit | 26e52332eb28812b3415aaefc6f53a7637a222fe (patch) | |
| tree | 9a18aea5a1d2fab6bf22e95848f9d611d9ff57e3 /docs | |
| parent | 6360791cb71b04730c2b1704b35ad5e45fddd150 (diff) | |
Add index with submodules
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>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/index.rst | 59 |
1 files changed, 31 insertions, 28 deletions
diff --git a/docs/index.rst b/docs/index.rst index 4923d700d..98ee19f84 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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 |