diff options
author | 2017-02-08 12:30:04 -0600 | |
---|---|---|
committer | 2017-02-21 16:26:16 +0000 | |
commit | e8d3e7ce3dcd310f99118ebb7d380898b4738ec8 (patch) | |
tree | 7c9cfcf5f880501b0e456b5bb6078c178724d59e /docs | |
parent | 488ac852c3a553bb01db8dce0e70876fda44e5c0 (diff) |
Update to new OPNFV Docs structure
JIRA: MODELS-2
Change-Id: I5d5601849803cf017bab882dc6eba931637b0770
Signed-off-by: Aimee Ukasick <aimeeu.opensource@gmail.com>
Diffstat (limited to 'docs')
28 files changed, 252 insertions, 107 deletions
diff --git a/docs/design/featureconfig_link.rst b/docs/design/featureconfig_link.rst deleted file mode 100644 index 6af66f7..0000000 --- a/docs/design/featureconfig_link.rst +++ /dev/null @@ -1,2 +0,0 @@ -.. include:: - ../installationprocedure/feature.configuration.rst diff --git a/docs/design/featureusage_link.rst b/docs/design/featureusage_link.rst deleted file mode 100644 index c3ac10b..0000000 --- a/docs/design/featureusage_link.rst +++ /dev/null @@ -1,2 +0,0 @@ -.. include:: - ../userguide/feature.usage.rst diff --git a/docs/design/index.rst b/docs/design/index.rst deleted file mode 100644 index 982f2a6..0000000 --- a/docs/design/index.rst +++ /dev/null @@ -1,20 +0,0 @@ -.. 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 Copper Project -******************** - -.. toctree:: - :numbered: - :maxdepth: 4 - - introduction.rst - releasenotes_link.rst - definitions.rst - usecases.rst - featureconfig_link.rst - postinstall_link.rst - featureusage_link.rst diff --git a/docs/design/postinstall_link.rst b/docs/design/postinstall_link.rst deleted file mode 100644 index ca8d99c..0000000 --- a/docs/design/postinstall_link.rst +++ /dev/null @@ -1,2 +0,0 @@ -.. include:: - ../installationprocedure/installation.instruction.rst diff --git a/docs/design/releasenotes_link.rst b/docs/design/releasenotes_link.rst deleted file mode 100644 index 6ee81a3..0000000 --- a/docs/design/releasenotes_link.rst +++ /dev/null @@ -1,2 +0,0 @@ -.. include:: - ../releasenotes/release.notes.rst diff --git a/docs/development/design/architecture.rst b/docs/development/design/architecture.rst new file mode 100644 index 0000000..d591082 --- /dev/null +++ b/docs/development/design/architecture.rst @@ -0,0 +1,15 @@ +.. 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 Danube Architecture +================================ + +.. contents:: + :depth: 3 + :local: + +Please see the OPNFV Models `wiki <https://wiki.opnfv.org/display/models>`_ +for details on Models project's architecture. diff --git a/docs/design/definitions.rst b/docs/development/design/definitions.rst index 426abda..426abda 100644 --- a/docs/design/definitions.rst +++ b/docs/development/design/definitions.rst diff --git a/docs/development/design/index.rst b/docs/development/design/index.rst new file mode 100644 index 0000000..3fd61ee --- /dev/null +++ b/docs/development/design/index.rst @@ -0,0 +1,15 @@ +.. 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 Danube Design +============================ + +.. toctree:: + :maxdepth: 1 + + definitions + architecture + diff --git a/docs/development/overview/index.rst b/docs/development/overview/index.rst new file mode 100644 index 0000000..07bdc43 --- /dev/null +++ b/docs/development/overview/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 Models Danube Overview +============================ + +.. toctree:: + :maxdepth: 1 + + overview diff --git a/docs/design/introduction.rst b/docs/development/overview/overview.rst index ee4cee2..4b0d31f 100644 --- a/docs/design/introduction.rst +++ b/docs/development/overview/overview.rst @@ -3,23 +3,20 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) 2015-2017 AT&T Intellectual Property, Inc -Introduction -============ - -.. - This work is licensed under a Creative Commons Attribution 4.0 Unported License. - - http://creativecommons.org/licenses/by/4.0 +============================ +OPNFV Models Danube Overview +============================ -.. NOTE:: - This is the working documentation for the Models project. +.. contents:: + :depth: 3 + :local: -The `OPNFV Models <https://wiki.opnfv.org/display/models>`_ project aims to address +Introduction +------------ +The `OPNFV Models <https://wiki.opnfv.org/display/models>`_ project addresses various goals for promoting availability and convergence of information and/or data models related to NFV service/VNF management, as being defined in Standards (SDOs) and as developed in Open Source projects. -The documentation provided here focuses on the specific features supported in the Danube release. - diff --git a/docs/development/requirements/index.rst b/docs/development/requirements/index.rst new file mode 100644 index 0000000..f6e6b88 --- /dev/null +++ b/docs/development/requirements/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 Models Danube Requirements +================================ + +.. toctree:: + :maxdepth: 1 + + requirements diff --git a/docs/development/requirements/requirements.rst b/docs/development/requirements/requirements.rst new file mode 100644 index 0000000..375f85d --- /dev/null +++ b/docs/development/requirements/requirements.rst @@ -0,0 +1,15 @@ +.. 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 Danube Requirements +================================ + +.. contents:: + :depth: 3 + :local: + +Please see the OPNFV Models `wiki <https://wiki.opnfv.org/display/models>`_ +for details on Models project's development requirements. diff --git a/docs/installationprocedure/index.rst b/docs/installationprocedure/index.rst deleted file mode 100644 index 2776b88..0000000 --- a/docs/installationprocedure/index.rst +++ /dev/null @@ -1,10 +0,0 @@ -*********************************** -OPNFV Copper Installation Procedure -*********************************** - -.. toctree:: - :numbered: - :maxdepth: 4 - - feature.configuration.rst - installation.instruction.rst diff --git a/docs/installationprocedure/feature.configuration.rst b/docs/release/configguide/featureconfig.rst index 57b490d..1407212 100644 --- a/docs/installationprocedure/feature.configuration.rst +++ b/docs/release/configguide/featureconfig.rst @@ -3,30 +3,20 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) 2015-2017 AT&T Intellectual Property, Inc -Models Configuration -==================== +========================== +OPNFV Models Configuration +========================== +.. contents:: + :depth: 3 + :local: -Pre-configuration Activities ----------------------------- -None required. - -Hardware Configuration +Hardware configuration ---------------------- -There is no specific hardware configuration required for the Models project. - -Feature Configuration ---------------------- - -OPNFV Installer Support -....................... - There is currently no OPNFV installer support for the components used by the Models project. - -Manual Installation -................... - +Feature configuration +--------------------- The Models test scripts automatically install Models components. Instructions are included in the following scripts: * models/tests/vHello_Tacker.sh @@ -35,4 +25,3 @@ Prerequisites to using vHello_Tacker: * OPFNV installed via JOID or Apex * a plain OpenStack installation such as DevStack - 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..ed531d3 --- /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 Models Installation +========================= + +.. toctree:: + :maxdepth: 1 + + installation.instruction diff --git a/docs/installationprocedure/installation.instruction.rst b/docs/release/installation/installation.instruction.rst index 0500738..0500738 100644 --- a/docs/installationprocedure/installation.instruction.rst +++ b/docs/release/installation/installation.instruction.rst diff --git a/docs/release/release-notes/index.rst b/docs/release/release-notes/index.rst new file mode 100644 index 0000000..7302a7a --- /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 Models 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..d46386b --- /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 Models Release Notes +========================== + +This document provides the release notes for the Danube Release of Models. + +.. 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 Models 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..c6bf5ff --- /dev/null +++ b/docs/release/scenarios/scenario.name/index.rst @@ -0,0 +1,15 @@ +.. 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 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..b690ea8 --- /dev/null +++ b/docs/release/scenarios/scenario.name/scenario.description.rst @@ -0,0 +1,19 @@ +.. 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 Scenarios +====================== + +This document provides scenario level details for the Danube release of Models. + +.. contents:: + :depth: 3 + :local: + +Introduction +------------ + +There are no scenarios at this time. diff --git a/docs/userguide/feature.usage.rst b/docs/release/userguide/feature.userguide.rst index ec628bb..59ecccf 100644 --- a/docs/userguide/feature.usage.rst +++ b/docs/release/userguide/feature.userguide.rst @@ -3,10 +3,16 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) 2015-2017 AT&T Intellectual Property, Inc -Models Capabilities and Usage -============================= +======================= +OPNFV Models User Guide +======================= + +.. contents:: + :depth: 3 + :local: Current information on the capabilities of the Models project can be found on the Models `wiki <https://wiki.opnfv.org/display/models>`_. Examples of test usage can be found on the Models `testing <https://wiki.opnfv.org/display/models/Testing>`_ page. + diff --git a/docs/releasenotes/release.notes.rst b/docs/release/userguide/index.rst index 410d1cd..bd09cb1 100644 --- a/docs/releasenotes/release.notes.rst +++ b/docs/release/userguide/index.rst @@ -3,16 +3,14 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) 2015-2017 AT&T Intellectual Property, Inc -Release Notes -============= +======================= +OPNFV Models User Guide +======================= -Models Danube Release Scope ---------------------------- - -OPNFV Danube includes: - - * Further enhancements of Models test scripts +.. toctree:: + :maxdepth: 1 + feature.userguide diff --git a/docs/releasenotes/index.rst b/docs/releasenotes/index.rst deleted file mode 100644 index a999c8e..0000000 --- a/docs/releasenotes/index.rst +++ /dev/null @@ -1,9 +0,0 @@ -************************** -OPNFV Models Release Notes -************************** - -.. toctree:: - :numbered: - :maxdepth: 4 - - release.notes.rst diff --git a/docs/testing/index.rst b/docs/testing/index.rst new file mode 100644 index 0000000..1be820f --- /dev/null +++ b/docs/testing/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 Models Testing +==================== + +.. toctree:: + :maxdepth: 1 + + usecases.rst diff --git a/docs/design/usecases.rst b/docs/testing/usecases.rst index 4789fa5..c736ac7 100644 --- a/docs/design/usecases.rst +++ b/docs/testing/usecases.rst @@ -3,8 +3,9 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) 2015-2017 AT&T Intellectual Property, Inc -Use Cases -========= +====================== +OPNFV Models Use Cases +====================== Implemented in Current Release ------------------------------ @@ -17,12 +18,5 @@ as extended for testing of more Tacker-supported features as of OpenStack Newton A single-node simple python web server, connected to two internal networks (private and admin), and accessible via a floating IP. - -Cloudify Hello World -.................... - -Deployment test for the Cloudify Hello World blueprint - - A complete list of use cases is located on the `Models Testing <https://wiki.opnfv.org/display/models/Testing>`_ wiki page. diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst deleted file mode 100644 index 6e45330..0000000 --- a/docs/userguide/index.rst +++ /dev/null @@ -1,9 +0,0 @@ -*********************** -OPNFV Models User Guide -*********************** - -.. toctree:: - :numbered: - :maxdepth: 4 - - feature.usage.rst |