From 59b1fbbd5f6796b184a283c928d9e9154678df55 Mon Sep 17 00:00:00 2001 From: ChristopherPrice Date: Tue, 13 Sep 2016 10:18:33 +0200 Subject: A compact version of the documentation library. This document provides a master branch link to all Colorado related documentation. The patch to Stable will update all release links to /colorado/docs/ but for the time being this document should remaina accurate on master. Change-Id: I47feb62980311f6f76ddc44ef6e46a0999690a8f Signed-off-by: ChristopherPrice (cherry picked from commit dbd5a28b6810d9711f1aa97819a89c02e1d3ddc5) --- docs/documentation/index.rst | 157 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 157 insertions(+) create mode 100644 docs/documentation/index.rst diff --git a/docs/documentation/index.rst b/docs/documentation/index.rst new file mode 100644 index 000000000..2d8d2b761 --- /dev/null +++ b/docs/documentation/index.rst @@ -0,0 +1,157 @@ +.. 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 +******************* + +===================== +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 `_ +* `Installation & configuration guide `_ +* `The 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 +============================= + +---------------------------------------------- +Copper, policy features, release documentation +---------------------------------------------- + +* `Copper release documentation `_ + +----------------------------------------------------- +Doctor, fault notification, features and capabilities +----------------------------------------------------- + +* `The doctor overview document `_ +* `Doctor user guide `_ + +---------------------------------------------------------------- +Domino, template distribution service, features and capabilities +---------------------------------------------------------------- + +* `User guide `_ +* `Configuration guide `_ + +------------------------------------------------- +FastDataStacks feature and scenario documentation +------------------------------------------------- + +* `Neutron integrated fd.io scenario description `_ +* `OpenDaylight integrated fd.io scenario description `_ + +--------------------------------------- +High Availability in the OPNFV platform +--------------------------------------- + +Needs to be confirmed where the HA docs will come from. + +* `High availability scenarios `_ +* `Platform needs for supporting high availability `_ + + +------------------------------------ +IPv6 platform support and capability +------------------------------------ + +* `IPv6 user guide `_ +* `Installation of routing functions `_ + +----------- +KVM for NFV +----------- + +* `Installation guide `_ +* `User guide `_ +* `Configuration guide `_ +* `Release notes `_ + +------------------------- +Network readiness project +------------------------- + +* `Network readiness report `_ + +---------------------- +ONOS framework project +---------------------- + +* `Installation guide `_ +* `User guide `_ + +---------------------------- +OVSNFV release documentation +---------------------------- + +* `Configuration guide `_ +* `User guide `_ +* `Release notes `_ +* `OVS for NFV scenario description `_ + +-------------- +Parser project +-------------- + +* `Parser release documentation `_ +* `Installation guide `_ +* `User guide `_ + +Test Project documentation +========================== + +---------------------- +Functest documentation +---------------------- + +* `The Functest configuration guide `_ +* `The Functest user Guide `_ +* `A developer guide for working with functest `_ +* `Functest release Notes `_ + +----------------------- +Yardstick documentation +----------------------- + +* `The Yardstick user guide `_ +* `A code documentation and developer guide `_ +* `Yardstick release notes `_ + +------------------------- +vSwitchPerf documentation +------------------------- + +* `Release and development documentation `_ + +------------------------------------------------ +Software fast-path quality metrics documentation +------------------------------------------------ + +* `Release and development documentation `_ + +------------------------- +Bottlenecks documentation +------------------------- + +* `Installation procedure `_ -- cgit 1.2.3-korg