diff options
author | Aimee Ukasick <aimeeu.opensource@gmail.com> | 2017-02-09 09:54:13 -0600 |
---|---|---|
committer | Aimee Ukasick <aimeeu.opensource@gmail.com> | 2017-02-09 09:54:13 -0600 |
commit | 0655e7e09e0e4368c962c96b0db537b4c7a7cd37 (patch) | |
tree | 6a9e22f50220d057e0e948a69feb2dd43ae69bbf /docs/release | |
parent | f203fb89c37f7b8ae471346fa3fb59bc929290da (diff) |
Update for Danube doc structure
JIRA: VES-1
Change-Id: I4c804f65e485f4d4d539263c6702212015d9c99b
Signed-off-by: Aimee Ukasick <aimeeu.opensource@gmail.com>
Diffstat (limited to 'docs/release')
-rw-r--r-- | docs/release/configguide/featureconfig.rst | 26 | ||||
-rw-r--r-- | docs/release/configguide/index.rst | 14 | ||||
-rw-r--r-- | docs/release/configguide/postinstall.rst | 26 | ||||
-rw-r--r-- | docs/release/installation/index.rst | 13 | ||||
-rw-r--r-- | docs/release/installation/installation.instruction.rst | 13 | ||||
-rw-r--r-- | docs/release/release-notes/index.rst | 13 | ||||
-rw-r--r-- | docs/release/release-notes/release-notes.rst | 33 | ||||
-rw-r--r-- | docs/release/scenarios/scenario.name/index.rst | 14 | ||||
-rw-r--r-- | docs/release/scenarios/scenario.name/scenario.description.rst | 18 | ||||
-rw-r--r-- | docs/release/userguide/feature.userguide.rst | 18 | ||||
-rw-r--r-- | docs/release/userguide/index.rst | 16 |
11 files changed, 204 insertions, 0 deletions
diff --git a/docs/release/configguide/featureconfig.rst b/docs/release/configguide/featureconfig.rst new file mode 100644 index 0000000..8f36f82 --- /dev/null +++ b/docs/release/configguide/featureconfig.rst @@ -0,0 +1,26 @@ +.. This work is licensed under a +.. Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2015-2017 AT&T Intellectual Property, Inc + +======================= +OPNFV VES Configuration +======================= + +.. contents:: + :depth: 3 + :local: + +Hardware configuration +---------------------- +There is currently no OPNFV installer support for the components used by the VES project. + +Feature configuration +--------------------- +The VES test scripts automatically install VES components. Instructions are included in the following scripts: + + * ves/tests/vHello_VES.sh + +Prerequisites to using vHello_VES: + + * OPFNV installed via JOID or Apex diff --git a/docs/release/configguide/index.rst b/docs/release/configguide/index.rst new file mode 100644 index 0000000..2336694 --- /dev/null +++ b/docs/release/configguide/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 +.. (c) 2015-2017 AT&T Intellectual Property, Inc + +================================ +OPNFV Models Configuration Guide +================================ + +.. toctree:: + :maxdepth: 1 + + featureconfig + postinstall diff --git a/docs/release/configguide/postinstall.rst b/docs/release/configguide/postinstall.rst new file mode 100644 index 0000000..7367a5c --- /dev/null +++ b/docs/release/configguide/postinstall.rst @@ -0,0 +1,26 @@ +.. This work is licensed under a +.. Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2015-2017 AT&T Intellectual Property, Inc + +======================================== +OPNFV Models Post Installation Procedure +======================================== + + + +.. contents:: + :depth: 3 + :local: + +Automated post installation activities +-------------------------------------- +None + +Models post configuration procedures +------------------------------------ +None + +Platform components validation +------------------------------ +None diff --git a/docs/release/installation/index.rst b/docs/release/installation/index.rst new file mode 100644 index 0000000..53fd26a --- /dev/null +++ b/docs/release/installation/index.rst @@ -0,0 +1,13 @@ +.. This work is licensed under a +.. Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2015-2017 AT&T Intellectual Property, Inc + +====================== +OPNFV VES Installation +====================== + +.. toctree:: + :maxdepth: 1 + + installation.instruction diff --git a/docs/release/installation/installation.instruction.rst b/docs/release/installation/installation.instruction.rst new file mode 100644 index 0000000..de3f45e --- /dev/null +++ b/docs/release/installation/installation.instruction.rst @@ -0,0 +1,13 @@ +.. This work is licensed under a +.. Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2015-2017 AT&T Intellectual Property, Inc + +VES Post Installation Procedures +================================ + +None + + + + diff --git a/docs/release/release-notes/index.rst b/docs/release/release-notes/index.rst new file mode 100644 index 0000000..b0639bc --- /dev/null +++ b/docs/release/release-notes/index.rst @@ -0,0 +1,13 @@ +.. This work is licensed under a +.. Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2015-2017 AT&T Intellectual Property, Inc + +======================= +OPNFV VES Release Notes +======================= + +.. toctree:: + :maxdepth: 1 + + release-notes diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst new file mode 100644 index 0000000..34a3796 --- /dev/null +++ b/docs/release/release-notes/release-notes.rst @@ -0,0 +1,33 @@ +.. This work is licensed under a +.. Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2015-2017 AT&T Intellectual Property, Inc + +======================= +OPNFV VES Release Notes +======================= + +This document provides the release notes for the Danube Release of VES. + +.. contents:: + :depth: 3 + :local: + + +Version history +--------------- + ++--------------------+--------------------+--------------------+--------------------+ +| **Date** | **Ver.** | **Author** | **Comment** | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ +| 2017 8 Feb | 1.0.0 | Bryan Sullivan | | +| | | Aimee Ukasick | | ++--------------------+--------------------+--------------------+--------------------+ + +Summary +------- + +This release includes: + + * Further enhancements of VES test scripts diff --git a/docs/release/scenarios/scenario.name/index.rst b/docs/release/scenarios/scenario.name/index.rst new file mode 100644 index 0000000..d188cb5 --- /dev/null +++ b/docs/release/scenarios/scenario.name/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 +.. (c) 2015-2017 AT&T Intellectual Property, Inc + +=================== +OPNFV VES Scenarios +=================== + +.. toctree:: + :maxdepth: 1 + + scenario.description + diff --git a/docs/release/scenarios/scenario.name/scenario.description.rst b/docs/release/scenarios/scenario.name/scenario.description.rst new file mode 100644 index 0000000..005d537 --- /dev/null +++ b/docs/release/scenarios/scenario.name/scenario.description.rst @@ -0,0 +1,18 @@ +.. This work is licensed under a +.. Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2015-2017 AT&T Intellectual Property, Inc + +=================== +OPNFV VES Scenarios +=================== + +This document provides scenario level details for the Danube release of VES. + +.. contents:: + :depth: 3 + :local: + +Introduction +------------ +There are no formal scenarios at this time. diff --git a/docs/release/userguide/feature.userguide.rst b/docs/release/userguide/feature.userguide.rst new file mode 100644 index 0000000..d9fd787 --- /dev/null +++ b/docs/release/userguide/feature.userguide.rst @@ -0,0 +1,18 @@ +.. This work is licensed under a +.. Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2015-2017 AT&T Intellectual Property, Inc + +==================== +OPNFV VES User Guide +==================== + +.. contents:: + :depth: 3 + :local: + +Current information on the capabilities of the VES project can be found on the VES `wiki <https://wiki.opnfv.org/display/ves>`_. + +Examples of test usage can be found on the VES `Demo <https://https://wiki.opnfv.org/display/ves/vHello_VES+Demo>`_ page. + + diff --git a/docs/release/userguide/index.rst b/docs/release/userguide/index.rst new file mode 100644 index 0000000..39def0a --- /dev/null +++ b/docs/release/userguide/index.rst @@ -0,0 +1,16 @@ +.. This work is licensed under a +.. Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2015-2017 AT&T Intellectual Property, Inc + +==================== +OPNFV VES User Guide +==================== + +.. toctree:: + :maxdepth: 1 + + feature.userguide + + + |