Merge "A compact version of the documentation library."

1 files changed, 157 insertions, 0 deletions

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 <http://artifacts.opnfv.org/opnfvdocs/docs/overview/index.html>`_
+* `Installation & configuration guide <http://artifacts.opnfv.org/opnfvdocs/docs/installationprocedure/index.html>`_
+* `The OPNFV user guide <http://artifacts.opnfv.org/opnfvdocs/docs/userguide/index.html>`_
+
+Installation instructions
+=========================
+
+* `Apex installation instruction <http://artifacts.opnfv.org/apex/docs/installationprocedure/index.html>`_
+* `Apex release notes <http://artifacts.opnfv.org/apex/docs/releasenotes/index.html>`_
+* `Compass installation instruction <http://artifacts.opnfv.org/compass4nfv/docs/installationprocedure/index.html>`_
+* `Compass release notes <http://artifacts.opnfv.org/compass4nfv/docs/releasenotes/index.html>`_
+* `Fuel installation instruction <http://artifacts.opnfv.org/fuel/docs/installationprocedure/index.html>`_
+* `Fuel release notes <http://artifacts.opnfv.org/fuel/docs/releasenotes/index.html>`_
+* `Joid installation instruction <http://artifacts.opnfv.org/joid/docs/installationprocedure/index.html>`_
+* `Joid release notes <http://artifacts.opnfv.org/joid/docs/releasenotes/index.html>`_
+
+Feature Project documentation
+=============================
+
+----------------------------------------------
+Copper, policy features, release documentation
+----------------------------------------------
+
+* `Copper release documentation <http://artifacts.opnfv.org/copper/docs/design/index.html>`_
+
+-----------------------------------------------------
+Doctor, fault notification, features and capabilities
+-----------------------------------------------------
+
+* `The doctor overview document <http://artifacts.opnfv.org/doctor/docs/platformoverview/index.html>`_
+* `Doctor user guide <http://artifacts.opnfv.org/doctor/docs/userguide/index.html>`_
+
+----------------------------------------------------------------
+Domino, template distribution service, features and capabilities
+----------------------------------------------------------------
+
+* `User guide <http://artifacts.opnfv.org/domino/docs/userguide/index.html>`_
+* `Configuration guide <http://artifacts.opnfv.org/domino/docs/configguide/index.html>`_
+
+-------------------------------------------------
+FastDataStacks feature and scenario documentation
+-------------------------------------------------
+
+* `Neutron integrated fd.io scenario description <http://artifacts.opnfv.org/fds/docs/scenarios_os-nosdn-fdio-noha/index.html>`_
+* `OpenDaylight integrated fd.io scenario description <http://artifacts.opnfv.org/fds/docs/scenarios_os-odl_l2-fdio-noha/index.html>`_
+
+---------------------------------------
+High Availability in the OPNFV platform
+---------------------------------------
+
+Needs to be confirmed where the HA docs will come from.
+
+* `High availability scenarios <https://wiki.opnfv.org/download/attachments/2926157/scenario_analysis_for_high_availability_in_nfv.pdf?version=1&modificationDate=1458849162000&api=v2>`_
+* `Platform needs for supporting high availability <https://wiki.opnfv.org/download/attachments/2926157/releases_brahmaputra_ha_requirement.pdf?version=1&modificationDate=1458849162000&api=v2>`_
+
+
+------------------------------------
+IPv6 platform support and capability
+------------------------------------
+
+* `IPv6 user guide <http://artifacts.opnfv.org/ipv6/docs/userguide/index.html>`_
+* `Installation of routing functions <http://artifacts.opnfv.org/ipv6/docs/reldoc/index.html>`_
+
+-----------
+KVM for NFV
+-----------
+
+* `Installation guide <http://artifacts.opnfv.org/kvmfornfv/docs/installationprocedure/index.html>`_
+* `User guide <http://artifacts.opnfv.org/kvmfornfv/docs/userguide/index.html>`_
+* `Configuration guide <http://artifacts.opnfv.org/kvmfornfv/docs/configurationguide/index.html>`_
+* `Release notes <http://artifacts.opnfv.org/kvmfornfv/docs/releasenotes/index.html>`_
+
+-------------------------
+Network readiness project
+-------------------------
+
+* `Network readiness report <http://artifacts.opnfv.org/netready/docs/requirements/index.html>`_
+
+----------------------
+ONOS framework project
+----------------------
+
+* `Installation guide <http://artifacts.opnfv.org/onosfw/docs/installationprocedure/index.html>`_
+* `User guide <http://artifacts.opnfv.org/onosfw/docs/userguide/index.html>`_
+
+----------------------------
+OVSNFV release documentation
+----------------------------
+
+* `Configuration guide <http://artifacts.opnfv.org/ovsnfv/docs/configguide/index.html>`_
+* `User guide <http://artifacts.opnfv.org/ovsnfv/docs/userguide/index.html>`_
+* `Release notes <http://artifacts.opnfv.org/ovsnfv/docs/release/index.html>`_
+* `OVS for NFV scenario description <http://artifacts.opnfv.org/ovsnfv/docs/scenarios_os-nosdn-ovs/index.html>`_
+
+--------------
+Parser project
+--------------
+
+* `Parser release documentation <http://artifacts.opnfv.org/parser/docs/parser_docs/index.html>`_
+* `Installation guide <http://artifacts.opnfv.org/parser/docs/installationprocedure/index.html>`_
+* `User guide <http://artifacts.opnfv.org/parser/docs/userguide/index.html>`_
+
+Test Project documentation
+==========================
+
+----------------------
+Functest documentation
+----------------------
+
+*  `The Functest configuration guide <http://artifacts.opnfv.org/functest/docs/configguide/index.html>`_
+*  `The Functest user Guide <http://artifacts.opnfv.org/functest/docs/userguide/index.html>`_
+*  `A developer guide for working with functest <http://artifacts.opnfv.org/functest/docs/devguide/index.html>`_
+*  `Functest release Notes <http://artifacts.opnfv.org/functest/docs/release-notes/functest-release.html>`_
+
+-----------------------
+Yardstick documentation
+-----------------------
+
+*  `The Yardstick user guide <http://artifacts.opnfv.org/yardstick/docs/userguide/index.html>`_
+*  `A code documentation and developer guide <http://artifacts.opnfv.org/yardstick/docs/apidocs/index.html>`_
+*  `Yardstick release notes <http://artifacts.opnfv.org/yardstick/docs/release/index.html>`_
+
+-------------------------
+vSwitchPerf documentation
+-------------------------
+
+* `Release and development documentation  <http://artifacts.opnfv.org/vswitchperf/docs/index.html>`_
+
+------------------------------------------------
+Software fast-path quality metrics documentation
+------------------------------------------------
+
+* `Release and development documentation <http://artifacts.opnfv.org/fastpathmetrics/docs/index.html>`_
+
+-------------------------
+Bottlenecks documentation
+-------------------------
+
+* `Installation procedure <http://artifacts.opnfv.org/bottlenecks/docs/installationprocedure/index.html>`_