Adding new structure for the genesis requirements doc. 55/10155/5
authorChristopherPrice <christopher.price@ericsson.com>
Wed, 17 Feb 2016 16:22:54 +0000 (17:22 +0100)
committerChristopherPrice <christopher.price@ericsson.com>
Sun, 21 Feb 2016 14:11:50 +0000 (15:11 +0100)
Also aligned heading levels for readability.

Change-Id: I1e673637c044dc84201e922c9d8b4e3142a2ad27
Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
docs/requirements/component-support.rst [moved from docs/sources/req-summary-support-matrix.rst with 97% similarity]
docs/requirements/index.rst [new file with mode: 0644]
docs/requirements/system.rst [moved from docs/sources/system-requirements.rst with 87% similarity]
docs/requirements/userexperience.rst [moved from docs/sources/ux-requirements.rst with 99% similarity]
docs/sources/artifacts-location.rst

similarity index 97%
rename from docs/sources/req-summary-support-matrix.rst
rename to docs/requirements/component-support.rst
index 307b059..8f7d732 100644 (file)
@@ -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 (file)
index 0000000..12f1c2a
--- /dev/null
@@ -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
+
similarity index 87%
rename from docs/sources/system-requirements.rst
rename to docs/requirements/system.rst
index 9dc08f1..d637112 100644 (file)
@@ -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:
-==================
+------------------
+
similarity index 99%
rename from docs/sources/ux-requirements.rst
rename to docs/requirements/userexperience.rst
index ec63d01..8e8e404 100644 (file)
@@ -4,7 +4,7 @@
 .. Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
 
-===============
+
 UX requirements
 ===============
 
index 8b674f0..468b9dd 100644 (file)
@@ -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"
+