summaryrefslogtreecommitdiffstats
path: root/docs/index.rst
diff options
context:
space:
mode:
authorAric Gardner <agardner@linuxfoundation.org>2016-10-25 10:30:19 -0400
committerAric Gardner <agardner@linuxfoundation.org>2016-10-25 10:30:19 -0400
commitd6a84a6bd718d5c6147c537745fbef4c2fc600da (patch)
tree94be6d740218c669f500971dad35135e48e4b883 /docs/index.rst
parent85dadc907574039b30cddf1d587dd87dface2a11 (diff)
Initial demo test
Change-Id: Ie3c62198239a773c83fa0a131e8add78e4a86741 Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst209
1 files changed, 209 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 000000000..d885d8f5c
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,209 @@
+.. 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 <http://artifacts.opnfv.org/opnfvdocs/colorado/docs/overview/index.html>`_
+* `OPNFV Installation instruction <http://artifacts.opnfv.org/opnfvdocs/colorado/docs/installationprocedure/index.html>`_
+* `OPNFV user guide <http://artifacts.opnfv.org/opnfvdocs/colorado/docs/userguide/index.html>`_
+
+Installation instructions
+=========================
+
+* `Apex installation instruction <http://artifacts.opnfv.org/apex/colorado/docs/installationprocedure/index.html>`_
+* `Apex release notes <http://artifacts.opnfv.org/apex/colorado/docs/releasenotes/index.html>`_
+* `Compass installation instruction <http://artifacts.opnfv.org/compass4nfv/colorado/docs/installationprocedure/index.html>`_
+* `Compass release notes <http://artifacts.opnfv.org/compass4nfv/colorado/docs/releasenotes/index.html>`_
+* `Fuel installation instruction <http://artifacts.opnfv.org/fuel/colorado/docs/installationprocedure/index.html>`_
+* `Fuel release notes <http://artifacts.opnfv.org/fuel/colorado/docs/releasenotes/index.html>`_
+* `Joid installation instruction <http://artifacts.opnfv.org/joid/colorado/docs/installationprocedure/index.html>`_
+* `Joid release notes <http://artifacts.opnfv.org/joid/colorado/docs/releasenotes/index.html>`_
+
+Feature project documentation
+=============================
+
+---------------
+ARMband project
+---------------
+
+* `Installation instruction <http://artifacts.opnfv.org/armband/colorado/docs/installationprocedure/index.html>`_
+* `Release notes <http://artifacts.opnfv.org/armband/colorado/docs/releasenotes/index.html>`_
+
+----------------------------------------------
+Copper release documentation
+----------------------------------------------
+
+* `Design documentation <http://artifacts.opnfv.org/copper/colorado/docs/design/index.html>`_
+* `Installation instruction <http://artifacts.opnfv.org/copper/colorado/docs/installationprocedure/index.html>`_
+* `User guide <http://artifacts.opnfv.org/copper/colorado/docs/userguide/index.html>`_
+* `Release notes <http://artifacts.opnfv.org/copper/colorado/docs/releasenotes/index.html>`_
+
+-----------------------------------------------------
+Doctor features and capabilities
+-----------------------------------------------------
+
+* `Project overview <http://artifacts.opnfv.org/doctor/colorado/docs/platformoverview/index.html>`_
+* `User guide <http://artifacts.opnfv.org/doctor/colorado/docs/userguide/index.html>`_
+* `Release notes <http://artifacts.opnfv.org/doctor/colorado/docs/releasenotes/index.html>`_
+
+----------------------------------------------------------------
+Domino features and capabilities
+----------------------------------------------------------------
+
+* `User guide <http://artifacts.opnfv.org/domino/colorado/docs/userguide/index.html>`_
+
+-------------------------------------------------
+FastDataStacks feature and scenario documentation
+-------------------------------------------------
+
+* `OpenDaylight integrated fd.io scenario description <http://artifacts.opnfv.org/fds/colorado/scenarios_os-odl_l2-fdio-noha/index.html>`_
+
+------------------------------------
+IPv6 platform support and capability
+------------------------------------
+
+* `Configuration guide <http://artifacts.opnfv.org/ipv6/colorado/docs/installationprocedure/index.html>`_
+* `User guide <http://artifacts.opnfv.org/ipv6/colorado/docs/userguide/index.html>`_
+
+-----------
+KVM for NFV
+-----------
+
+* `Installation instruction <http://artifacts.opnfv.org/kvmfornfv/colorado/docs/installationprocedure/index.html>`_
+* `Configuration guide <http://artifacts.opnfv.org/kvmfornfv/colorado/docs/configurationguide/index.html>`_
+* `User guide <http://artifacts.opnfv.org/kvmfornfv/colorado/docs/userguide/index.html>`_
+* `Release notes <http://artifacts.opnfv.org/kvmfornfv/colorado/docs/releasenotes/index.html>`_
+
+--------------------------------
+MOON security management for NFV
+--------------------------------
+
+* `Project and Scenario overview <http://artifacts.opnfv.org/moon/colorado/docs/colorado_scenarios_os-odl_l2-moon-ha/index.html>`_
+* `Installation instruction <http://artifacts.opnfv.org/moon/colorado/docs/installationprocedure/index.html>`_
+* `Configuration guide <http://artifacts.opnfv.org/moon/colorado/docs/configurationguide/index.html>`_
+* `User guide <http://artifacts.opnfv.org/moon/colorado/docs/userguide/index.html>`_
+* `Release notes <http://artifacts.opnfv.org/moon/colorado/docs/releasenotes/index.html>`_
+
+----------------------------
+Multisite datacenter project
+----------------------------
+
+* `Installation instruction <http://artifacts.opnfv.org/multisite/colorado/installationprocedure/index.html>`_
+* `User guide <http://artifacts.opnfv.org/multisite/colorado/userguide/index.html>`_
+* `Release notes <http://artifacts.opnfv.org/multisite/colorado/releasenotes/index.html>`_
+
+-------------------------
+Network readiness project
+-------------------------
+
+* `Requirements document <http://artifacts.opnfv.org/netready/colorado/docs/requirements/index.html>`_
+
+----------------------
+ONOS framework project
+----------------------
+
+* `Installation instruction <http://artifacts.opnfv.org/onosfw/colorado/docs/installationprocedure/index.html>`_
+* `User guide <http://artifacts.opnfv.org/onosfw/colorado/docs/userguide/index.html>`_
+
+----------------------------
+OVSNFV release documentation
+----------------------------
+
+* `OVS for NFV scenario description <http://artifacts.opnfv.org/ovsnfv/colorado/docs/scenarios_os-nosdn-ovs/index.html>`_
+* `Configuration guide <http://artifacts.opnfv.org/ovsnfv/colorado/docs/configguide/index.html>`_
+* `User guide <http://artifacts.opnfv.org/ovsnfv/colorado/docs/userguide/index.html>`_
+
+--------------
+Parser project
+--------------
+
+* `Parser release documentation <http://artifacts.opnfv.org/parser/colorado/docs/parser_docs/index.html>`_
+* `Installation instruction <http://artifacts.opnfv.org/parser/colorado/docs/installationprocedure/index.html>`_
+* `User guide <http://artifacts.opnfv.org/parser/colorado/docs/userguide/index.html>`_
+
+------
+Pharos
+------
+
+* `Pharos specification <http://artifacts.opnfv.org/pharos/colorado/docs/specification/index.html>`_
+* `Configuration guide <http://artifacts.opnfv.org/pharos/colorado/docs/configguide/index.html>`_
+
+-------
+Promise
+-------
+
+* `Requirement specification <http://artifacts.opnfv.org/promise/colorado/docs/requirements/index.html>`_
+* `Installation and configuration guide <http://artifacts.opnfv.org/promise/colorado/docs/installationprocedure/index.html>`_
+* `User guide <http://artifacts.opnfv.org/promise/colorado/docs/userguide/index.html>`_
+
+------
+SDNVPN
+------
+
+* `BGPVPN scenario description <http://artifacts.opnfv.org/sdnvpn/colorado/docs/scenarios_os-odl_l2-bgpvpn/index.html>`_
+* `User guide <http://artifacts.opnfv.org/sdnvpn/colorado/docs/userguide/index.html>`_
+* `Release notes <http://artifacts.opnfv.org/sdnvpn/colorado/docs/release-notes/index.html>`_
+
+---
+SFC
+---
+
+* `Design documentation <http://artifacts.opnfv.org/sfc/colorado/docs/design/index.html>`_
+* `SFC scenario description <http://artifacts.opnfv.org/sfc/colorado/docs/scenarios_os-odl_l2-sfc-noha/index.html>`_
+* `High availability SFC scenario description <http://artifacts.opnfv.org/sfc/colorado/docs/scenarios_os-odl_l2-sfc-ha/index.html>`_
+* `Installation instruction <http://artifacts.opnfv.org/sfc/colorado/docs/installationprocedure/index.html>`_
+* `User guide <http://artifacts.opnfv.org/sfc/colorado/docs/userguide/index.html>`_
+* `Release notes <http://artifacts.opnfv.org/sfc/colorado/docs/releasenotes/index.html>`_
+
+------------------------------------------------
+Software fast-path quality metrics documentation
+------------------------------------------------
+
+* `Release and development documentation <http://artifacts.opnfv.org/fastpathmetrics/colorado/index.html>`_
+
+
+Test Project documentation
+==========================
+
+-------------------------
+Bottlenecks documentation
+-------------------------
+
+* `Installation instruction <http://artifacts.opnfv.org/bottlenecks/colorado/docs/installationprocedure/index.html>`_
+* `Release notes <http://artifacts.opnfv.org/bottlenecks/docs/releasenotes/index.html>`_
+
+----------------------
+Functest documentation
+----------------------
+
+* `Configuration guide <http://artifacts.opnfv.org/functest/colorado/docs/configguide/index.html>`_
+* `User guide <http://artifacts.opnfv.org/functest/colorado/docs/userguide/index.html>`_
+* `Developer guide <http://artifacts.opnfv.org/functest/colorado/docs/devguide/index.html>`_
+* `Release notes <http://artifacts.opnfv.org/functest/colorado/docs/release-notes/functest-release.html>`_
+
+-------------------------
+vSwitchPerf documentation
+-------------------------
+
+* `Release and development documentation <http://artifacts.opnfv.org/vswitchperf/colorado/docs/index.html>`_
+
+-----------------------
+Yardstick documentation
+-----------------------
+
+* `User guide <http://artifacts.opnfv.org/yardstick/colorado/docs/userguide/index.html>`_
+* `Release notes <http://artifacts.opnfv.org/yardstick/colorado/docs/release/index.html>`_
+