summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorChristopherPrice <christopher.price@ericsson.com>2016-02-17 17:22:54 +0100
committerFrank Brockners <fbrockne@cisco.com>2016-02-21 19:29:00 +0000
commit3e58c518900cf5c09f405b3e0289ecd3e6fc9171 (patch)
tree8ca10968136960f0683c33a9a15ab16692137efb /docs
parent7c9135f39598b4da9595436e7266be4f9301e536 (diff)
Adding new structure for the genesis requirements doc.
Also aligned heading levels for readability. Change-Id: I1e673637c044dc84201e922c9d8b4e3142a2ad27 Signed-off-by: ChristopherPrice <christopher.price@ericsson.com> (cherry picked from commit 923a3c337a44ee44a5a673b0bec8fe46c4b24096)
Diffstat (limited to 'docs')
-rw-r--r--docs/requirements/component-support.rst (renamed from docs/sources/req-summary-support-matrix.rst)7
-rw-r--r--docs/requirements/index.rst14
-rw-r--r--docs/requirements/system.rst (renamed from docs/sources/system-requirements.rst)16
-rw-r--r--docs/requirements/userexperience.rst (renamed from docs/sources/ux-requirements.rst)2
-rw-r--r--docs/sources/artifacts-location.rst3
5 files changed, 30 insertions, 12 deletions
diff --git a/docs/sources/req-summary-support-matrix.rst b/docs/requirements/component-support.rst
index 307b059..8f7d732 100644
--- a/docs/sources/req-summary-support-matrix.rst
+++ b/docs/requirements/component-support.rst
@@ -1,4 +1,9 @@
-===============================
+.. Copyright 2015 Open Platform for NFV Project, Inc. and its contributors
+
+.. This work is licensed under the
+.. Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
Deployment tools support matrix
===============================
diff --git a/docs/requirements/index.rst b/docs/requirements/index.rst
new file mode 100644
index 0000000..12f1c2a
--- /dev/null
+++ b/docs/requirements/index.rst
@@ -0,0 +1,14 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+==========================================
+OPNFV deployment tools common requirements
+==========================================
+
+.. toctree::
+ :maxdepth: 2
+
+ ./userexperience.rst
+ ./system.rst
+ ./component-support.rst
+
diff --git a/docs/sources/system-requirements.rst b/docs/requirements/system.rst
index 9dc08f1..d637112 100644
--- a/docs/sources/system-requirements.rst
+++ b/docs/requirements/system.rst
@@ -10,7 +10,6 @@
particular installer creates.
Please add a bullet each for every requirement added.
-==========================
Target system requirements
==========================
@@ -24,26 +23,26 @@ and/or configure.
Minimum base Operating System distribution supported:
-=====================================================
+-----------------------------------------------------
* `GENESIS-4 <https://jira.opnfv.org/browse/GENESIS-4>`_:
Installers should support either Centos 7 or Ubuntu 14.04
as target system base OS.
Components/features installed for OpenStack:
-============================================
+--------------------------------------------
* `GENESIS-53 <https://jira.opnfv.org/browse/GENESIS-53>`_:
OpenStack Heat should be installed.
Minimum base OpenStack distribution supported:
-==============================================
+----------------------------------------------
* `GENESIS-7 <https://jira.opnfv.org/browse/GENESIS-7>`_:
Installers should support OpenStack Liberty release.
SDN Controller:
-===============
+---------------
* `GENESIS-6 <https://jira.opnfv.org/browse/GENESIS-6>`_:
Installers should support OpenDaylight Beryllium Release.
@@ -52,13 +51,14 @@ SDN Controller:
Installers should support ONOSFW.
VM Controller:
-==============
+--------------
Hypervisor:
-===========
+-----------
* `GENESIS-8 <https://jira.opnfv.org/browse/GENESIS-8>`_:
Installers should support KVM hypervisor.
Virtual forwarder:
-==================
+------------------
+
diff --git a/docs/sources/ux-requirements.rst b/docs/requirements/userexperience.rst
index ec63d01..8e8e404 100644
--- a/docs/sources/ux-requirements.rst
+++ b/docs/requirements/userexperience.rst
@@ -4,7 +4,7 @@
.. Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
-===============
+
UX requirements
===============
diff --git a/docs/sources/artifacts-location.rst b/docs/sources/artifacts-location.rst
index 8b674f0..468b9dd 100644
--- a/docs/sources/artifacts-location.rst
+++ b/docs/sources/artifacts-location.rst
@@ -19,8 +19,6 @@ VM manager components
* OpenStack::
location: `<http://docs.openstack.org/releases/releases/liberty.html>`_
- release: Liberty
-
joid_location: cloud-archive:liberty
release: Liberty
@@ -99,3 +97,4 @@ JOID components
branch: "lp:~wuwenbin2/onosfw/onos-controller"
branch: "lp:~wuwenbin2/onosfw/neutron-api-onos"
branch: "lp:~wuwenbin2/onosfw/openvswitch-onos"
+