diff options
author | Frank Brockners <fbrockne@cisco.com> | 2016-01-21 03:25:16 -0800 |
---|---|---|
committer | Frank Brockners <fbrockne@cisco.com> | 2016-01-21 03:25:16 -0800 |
commit | ac5b3315a20bad9a5a86740254cf6798c1b02456 (patch) | |
tree | fd416e8ed3c5a30eeb598c97d2823442da698a1f /docs/sources/system-requirements.rst | |
parent | 4cbb1cb42c772877052e0786e391ae38d907f31a (diff) |
Editorial updates to requirements docs
Updates to system-requirements and ux-requirements docs.
- Fixed formatting
- Fixed broken links
- Moved documentation requirements from system-req
document to ux-req document
- Fixed (some) grammar
Note that non editorial fixes (e.g. removal for
certain requirements no longer apply to Brahmaputra
are handled in other patches). This patch is a replica
of 7435 which got abandoned due to merge issues.
Change-Id: Ibb914f523a7719f8240d4a690cd645f44500108e
Signed-off-by: Frank Brockners <fbrockne@cisco.com>
Diffstat (limited to 'docs/sources/system-requirements.rst')
-rw-r--r-- | docs/sources/system-requirements.rst | 52 |
1 files changed, 21 insertions, 31 deletions
diff --git a/docs/sources/system-requirements.rst b/docs/sources/system-requirements.rst index bbf916a..ca7af03 100644 --- a/docs/sources/system-requirements.rst +++ b/docs/sources/system-requirements.rst @@ -24,59 +24,49 @@ Target system requirements Release: OPNFV Brahmaputra -This document lists requirements for the target system that an installer creates. Different from the requirements document on user-experience, this document focuses on the key hardware and software components the different deployment tools install and/or configure. +This document lists requirements for the target system that +an installer creates. Different from the requirements document +on user-experience, this document focuses on the key hardware +and software components the different deployment tools install +and/or configure. -Hardware components -------------------- -.. Please add the Jira story reference to each requirement. - Note that the below listed "GENESIS-1" Jira story are place holders - and are to be changed for the actual Jira reference. - - -Software components -------------------- -.. Please add the Jira story to each requirement as reference. Minimum base Operating System distribution supported: ===================================================== -`GENESIS-4 <https://jira.opnfv.org/browse/GENESIS-4>`_: Installers support either Centos 7 or -Ubuntu 14.04 as target system base OS + +* `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. +* `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 must support OpenStack Liberty -release + +* `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 support -OpenDaylight Lithium Release - -`GENESIS-49 <https://jira.opnfv.org/browse/GENESIS-49>`_: Installers support for ONOSFW +* `GENESIS-6 <https://jira.opnfv.org/browse/GENESIS-6>`_: + Installers should support OpenDaylight Lithium Release. +* `GENESIS-49 <https://jira.opnfv.org/browse/GENESIS-49>`_: + Installers should support ONOSFW. VM Controller: ============== Hypervisor: =========== -`GENESIS-8 <https://jira.opnfv.org/browse/GENESIS-8>`_: KVM Support + +* `GENESIS-8 <https://jira.opnfv.org/browse/GENESIS-8>`_: + Installers should support KVM hypervisor. Virtual forwarder: ================== - - -Installer Documentation: -======================== - -`GENESIS-34 <https://jira.opnfv.org/browse/GENESIS-34`_: Installers should provide a user guide - -`GENESIS-35 <https://jira.opnfv.org/browse/GENESIS-35`_: Installers should provide release notes for an OPNFV release as part of the documentation provided - - |