From: ShubhamRathi Date: Tue, 21 Mar 2017 18:22:48 +0000 (+0530) Subject: Add new index page X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=commitdiff_plain;h=refs%2Fheads%2Fstable%2Fcolorado;p=opnfvdocs.git Add new index page Change-Id: I332136b06872a91355f8450c0e73f95fbfbf3b27 Signed-off-by: ShubhamRathi --- diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 000000000..505fa5f1e --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,208 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) Open Platform for NFV Project, Inc. and its contributors + +******************* +OPNFV Documentation +******************* + +============================== +Colorado Release Documentation +============================== + +OPNFV release documentation is structured with brief platform-level documents referencing +more detailed installation instructions and descriptive documentation. + +Platform documentation +====================== + +* `OPNFV platform overview document `_ +* `OPNFV Installation instruction `_ +* `OPNFV user guide `_ + +Installation instructions +========================= + +* `Apex installation instruction `_ +* `Apex release notes `_ +* `Compass installation instruction `_ +* `Compass release notes `_ +* `Fuel installation instruction `_ +* `Fuel release notes `_ +* `Joid installation instruction `_ +* `Joid release notes `_ + +Feature project documentation +============================= + +--------------- +ARMband project +--------------- + +* `Installation instruction `_ +* `Release notes `_ + +---------------------------- +Copper release documentation +---------------------------- + +* `Design documentation `_ +* `Installation instruction `_ +* `User guide `_ +* `Release notes `_ + +-------------------------------- +Doctor features and capabilities +-------------------------------- + +* `Project overview `_ +* `User guide `_ +* `Release notes `_ + +-------------------------------- +Domino features and capabilities +-------------------------------- + +* `User guide `_ + +------------------------------------------------- +FastDataStacks feature and scenario documentation +------------------------------------------------- + +* `OpenDaylight integrated fd.io scenario description `_ +* `FD.io based forwarding for OPNFV `os-nosdn-fdio-noha `_ + +------------------------------------ +IPv6 platform support and capability +------------------------------------ + +* `Configuration guide `_ +* `User guide `_ + +----------- +KVM for NFV +----------- + +* `Installation instruction `_ +* `Configuration guide `_ +* `User guide `_ +* `Release notes `_ + +-------------------------------- +MOON security management for NFV +-------------------------------- + +* `Project and Scenario overview `_ +* `Installation instruction `_ +* `User guide `_ +* `Release notes `_ + +---------------------------- +Multisite datacenter project +---------------------------- + +* `Installation instruction `_ +* `User guide `_ +* `Release notes `_ + +------------------------- +Network readiness project +------------------------- + +* `Requirements document `_ + +---------------------- +ONOS framework project +---------------------- + +* `Installation instruction `_ +* `User guide `_ + +---------------------------- +OVSNFV release documentation +---------------------------- + +* `OVS for NFV scenario description `_ +* `Configuration guide `_ +* `User guide `_ + +-------------- +Parser project +-------------- + +* `Parser release documentation `_ +* `Installation instruction `_ +* `User guide `_ + +------ +Pharos +------ + +* `Pharos specification `_ +* `Configuration guide `_ + +------- +Promise +------- + +* `Requirement specification `_ +* `Installation and configuration guide `_ +* `User guide `_ + +------ +SDNVPN +------ + +* `BGPVPN scenario description `_ +* `User guide `_ +* `Release notes `_ + +--- +SFC +--- + +* `Design documentation `_ +* `SFC scenario description `_ +* `High availability SFC scenario description `_ +* `Installation instruction `_ +* `User guide `_ +* `Release notes `_ + +------------------------------------------------ +Software fast-path quality metrics documentation +------------------------------------------------ + +* `Release and development documentation `_ + +Test Project documentation +========================== + +------------------------- +Bottlenecks documentation +------------------------- + +* `Installation instruction `_ +* `Release notes `_ + +---------------------- +Functest documentation +---------------------- + +* `Configuration guide `_ +* `User guide `_ +* `Developer guide `_ +* `Release notes `_ + +------------------------- +vSwitchPerf documentation +------------------------- + +* `Release and development documentation `_ + +----------------------- +Yardstick documentation +----------------------- + +* `User guide `_ +* `Release notes `_ +