diff options
Diffstat (limited to 'docs/release')
| -rw-r--r-- | docs/release/configguide/feature.configuration.rst | 28 | ||||
| -rw-r--r-- | docs/release/configguide/featureconfig.rst | 35 | ||||
| -rw-r--r-- | docs/release/configguide/index.rst | 13 | ||||
| -rw-r--r-- | docs/release/configguide/postinstall.rst | 39 | ||||
| -rw-r--r-- | docs/release/installation/index.rst | 10 | ||||
| -rw-r--r-- | docs/release/userguide/feature.userguide.rst | 23 | ||||
| -rw-r--r-- | docs/release/userguide/index.rst | 23 |
7 files changed, 0 insertions, 171 deletions
diff --git a/docs/release/configguide/feature.configuration.rst b/docs/release/configguide/feature.configuration.rst deleted file mode 100644 index 2eb79f22..00000000 --- a/docs/release/configguide/feature.configuration.rst +++ /dev/null @@ -1,28 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) OPNFV, Intel Corporation and others. - -Abstract -======== -This document provides information on how to install the SampleVNF -features in OPNFV. - -SampleVNF feature desciription -======================== - -Hardware requirements -===================== - -Bare metal deployment on (OPNFV) lab -------------------------------------------- - -Virtual deployment ------------------- - - -Download the installer source code and artifact ------------------------------------------------ - -Installation procedures ------------------------ - diff --git a/docs/release/configguide/featureconfig.rst b/docs/release/configguide/featureconfig.rst deleted file mode 100644 index 45f9a5fc..00000000 --- a/docs/release/configguide/featureconfig.rst +++ /dev/null @@ -1,35 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) OPNFV, Intel Corporation and others. - -======== -Abstract -======== -Add a brief introduction to configure OPNFV with this specific feature including -dependancies on platform components, this description should be at a level that -will apply to any installer providing the pre-requisite components. - -.. contents:: - :depth: 3 - :local: - -Pre-configuration activities -============================ -Describe specific pre-configuration activities. This should include ensuring the -right components are installed by the installation tools as required for your -feature to function. Refer to the previous installer configuration chapters, -installations guide and release notes - - -Hardware configuration -====================== -Describe the hardware configuration needed for this specific feature - - -Feature configuration -===================== -Describe the procedures to configure your feature on the platform in order -that it is ready to use according to the feature instructions in the platform -user guide. Where applicable you should add content in the postinstall.rst -to validate the feature is configured for use. -(checking components are installed correctly etc...) diff --git a/docs/release/configguide/index.rst b/docs/release/configguide/index.rst deleted file mode 100644 index 7f7b2d9c..00000000 --- a/docs/release/configguide/index.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) OPNFV, Intel Corporation and others. - -********************************** -SampleVNF Configuration Guide -********************************** - -.. toctree:: - :maxdepth: 1 - - featureconfig - postinstall diff --git a/docs/release/configguide/postinstall.rst b/docs/release/configguide/postinstall.rst deleted file mode 100644 index 296d3023..00000000 --- a/docs/release/configguide/postinstall.rst +++ /dev/null @@ -1,39 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) OPNFV, Intel Corporation and others. - -************************************* -<Project> Post Installation Procedure -************************************* - -Add a brief introduction to the methods of validating the installation -according to this specific installer or feature. - -.. contents:: - :depth: 3 - :local: - - -Automated post installation activities -====================================== -Describe specific post installation activities performed by the OPNFV -deployment pipeline including testing activities and reports. Refer to -the relevant testing guides, results, and release notes. - -note: this section should be singular and derived from the test projects -once we have one test suite to run for all deploy tools. This is not the -case yet so each deploy tool will need to provide (hopefully very simillar) -documentation of this. - - -<Project> post configuration procedures -======================================= -Describe any deploy tool or feature specific scripts, tests or procedures -that should be carried out on the deployment post install and configuration -in this section. - - -Platform components validation -============================== -Describe any component specific validation procedures necessary for your -deployment tool in this section. diff --git a/docs/release/installation/index.rst b/docs/release/installation/index.rst deleted file mode 100644 index f7bb1907..00000000 --- a/docs/release/installation/index.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) OPNFV, Intel Corporation and others. - -*************************************** -SampleVNF Installation Instruction -*************************************** - -.. toctree:: - :maxdepth: 1 diff --git a/docs/release/userguide/feature.userguide.rst b/docs/release/userguide/feature.userguide.rst deleted file mode 100644 index 62259c7f..00000000 --- a/docs/release/userguide/feature.userguide.rst +++ /dev/null @@ -1,23 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) OPNFV, Intel Corporation and others. - -.. contents:: - :depth: 3 - :local: - -<Feature> description -===================== -.. Describe the specific features and how it is realised in the scenario in a brief manner -.. to ensure the user understand the context for the user guide instructions to follow. - -<Feature> capabilities and usage -================================ -.. Describe the specific capabilities and usage for <XYZ> feature. -.. Provide enough information that a user will be able to operate the feature on a deployed scenario. - -<Feature and API usage guidelines and example> -============================================== -.. Describe with examples how to use specific features, provide API examples and details required to -.. operate the feature on the platform. - diff --git a/docs/release/userguide/index.rst b/docs/release/userguide/index.rst deleted file mode 100644 index 8dba05e4..00000000 --- a/docs/release/userguide/index.rst +++ /dev/null @@ -1,23 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) OPNFV, Intel Corporation and others. - -===================== -SampleVNF User Guide -===================== - -.. The feature user guide should provide an OPNFV user with enough information to -.. use the features provided by the feature project in the supported scenarios. -.. This guide should walk a user through the usage of the features once a scenario -.. has been deployed and is active according to the installation guide provided -.. by the installer project. - -.. toctree:: - :maxdepth: 1 - - feature.userguide -.. The feature.userguide.rst file should contain the text for this document -.. additional documents can be added to this directory and added in the right order -.. to this file as a list below. - - |