From 7bde278edccd1008149a9204da133201fa6babbb Mon Sep 17 00:00:00 2001 From: ChristopherPrice Date: Fri, 1 Jul 2016 09:58:27 +0200 Subject: Establishing document structures for Colorado. Derived from converging patches 16165, 16047 & 15937 into one patch. Change-Id: I3c544ba2fa30856a50274bad9342a06eebc39d58 Signed-off-by: ChristopherPrice Co-Authored-By: Sofia Wallin --- docs/userguide/common.platform.render.rst | 26 ++++++++++++++++++++++++++ docs/userguide/feature-usage.rst | 15 --------------- docs/userguide/feature.userguide.render.rst | 15 +++++++++++++++ docs/userguide/feature.userguide.template.rst | 12 ++++++++++++ docs/userguide/featureusage.rst | 12 ------------ docs/userguide/general-system.rst | 26 -------------------------- docs/userguide/test-usage.rst | 17 ----------------- docs/userguide/testusage.rst | 12 ------------ 8 files changed, 53 insertions(+), 82 deletions(-) create mode 100644 docs/userguide/common.platform.render.rst delete mode 100644 docs/userguide/feature-usage.rst create mode 100644 docs/userguide/feature.userguide.render.rst create mode 100644 docs/userguide/feature.userguide.template.rst delete mode 100644 docs/userguide/featureusage.rst delete mode 100644 docs/userguide/general-system.rst delete mode 100644 docs/userguide/test-usage.rst delete mode 100644 docs/userguide/testusage.rst (limited to 'docs/userguide') diff --git a/docs/userguide/common.platform.render.rst b/docs/userguide/common.platform.render.rst new file mode 100644 index 000000000..1235c8f77 --- /dev/null +++ b/docs/userguide/common.platform.render.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) Christopher Price (Ericsson AB) + +================================ +Using common platform components +================================ + +This section outlines basic usage principals and methods for some of the commonly deployed +components of supported OPNFV scenario's in Brahmaputra. +The subsections provide an outline of how these components are commonly used and how to address them +in an OPNFV deployment. The components derive from autonomous upstream communities and where possible +this guide will provide direction to the relevant documentation made available by those communities +to better help you navigate the OPNFV deployment. + +Common VIM components +===================== + +.. include:: ./openstack.rst + +Common SDN components +===================== + +.. include:: ./opendaylight.rst +.. include:: ./onos.rst + diff --git a/docs/userguide/feature-usage.rst b/docs/userguide/feature-usage.rst deleted file mode 100644 index fa1186dc6..000000000 --- a/docs/userguide/feature-usage.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) Christopher Price (Ericsson AB) - -========================== -Using Brahmaputra Features -========================== - -The following sections of the user guide provide feature specific usage guidelines and references. -Providing users the necessary information to leveraging the features in the platform, -some operation in this section may refer back to the guides in the general system usage section. - -.. /docs/userguide/featureusage.rst files will be imported below by the build script. - - diff --git a/docs/userguide/feature.userguide.render.rst b/docs/userguide/feature.userguide.render.rst new file mode 100644 index 000000000..fa1186dc6 --- /dev/null +++ b/docs/userguide/feature.userguide.render.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) Christopher Price (Ericsson AB) + +========================== +Using Brahmaputra Features +========================== + +The following sections of the user guide provide feature specific usage guidelines and references. +Providing users the necessary information to leveraging the features in the platform, +some operation in this section may refer back to the guides in the general system usage section. + +.. /docs/userguide/featureusage.rst files will be imported below by the build script. + + diff --git a/docs/userguide/feature.userguide.template.rst b/docs/userguide/feature.userguide.template.rst new file mode 100644 index 000000000..f133134df --- /dev/null +++ b/docs/userguide/feature.userguide.template.rst @@ -0,0 +1,12 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) + + capabilities and usage +================================ +Describe the specific capabilities and usage for feature. + + +----------------------------------------------- +Describe with examples how to use specfic features. + diff --git a/docs/userguide/featureusage.rst b/docs/userguide/featureusage.rst deleted file mode 100644 index f133134df..000000000 --- a/docs/userguide/featureusage.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) - - capabilities and usage -================================ -Describe the specific capabilities and usage for feature. - - ------------------------------------------------ -Describe with examples how to use specfic features. - diff --git a/docs/userguide/general-system.rst b/docs/userguide/general-system.rst deleted file mode 100644 index 1235c8f77..000000000 --- a/docs/userguide/general-system.rst +++ /dev/null @@ -1,26 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) Christopher Price (Ericsson AB) - -================================ -Using common platform components -================================ - -This section outlines basic usage principals and methods for some of the commonly deployed -components of supported OPNFV scenario's in Brahmaputra. -The subsections provide an outline of how these components are commonly used and how to address them -in an OPNFV deployment. The components derive from autonomous upstream communities and where possible -this guide will provide direction to the relevant documentation made available by those communities -to better help you navigate the OPNFV deployment. - -Common VIM components -===================== - -.. include:: ./openstack.rst - -Common SDN components -===================== - -.. include:: ./opendaylight.rst -.. include:: ./onos.rst - diff --git a/docs/userguide/test-usage.rst b/docs/userguide/test-usage.rst deleted file mode 100644 index 423a3069d..000000000 --- a/docs/userguide/test-usage.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) Christopher Price (Ericsson AB) - -================================== -Using the test frameworks in OPNFV -================================== - -Testing is one of the key activities in OPNFV, validation can include component level testing, -system testing, automated deployment validation and performance characteristics testing. - -The following section outlines how to use the test projects that are delivered on the -OPNFV platform for the purpose of testing components and VNFs in the context of a -Brahmaputra deployment. - -.. /docs/userguide/testusage.rst files will be imported below by the build script. - diff --git a/docs/userguide/testusage.rst b/docs/userguide/testusage.rst deleted file mode 100644 index 9f9bdc9de..000000000 --- a/docs/userguide/testusage.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) - - capabilities and usage -================================ -Describe the specific capabilities and usage for testing. - - --------------------------------------- -Describe with examples how to use specfic test frameworks. - -- cgit 1.2.3-korg