diff options
author | ShubhamRathi <shubhamiiitbackup@gmail.com> | 2017-01-21 23:01:46 +0530 |
---|---|---|
committer | ShubhamRathi <shubhamiiitbackup@gmail.com> | 2017-01-22 22:14:54 +0530 |
commit | 9fa0278a6646da9a79a3384c1abf920ece189430 (patch) | |
tree | ee5447cbd6ff659213f8978c84a064a7e39cb7ab /docs/templates/release/configguide | |
parent | 7b7090d789c1044bd6058b3d33750d0e39cde2e0 (diff) |
Adding all templates under templates/
Templates for docs contribution have been
added under templates/ .Templates for release/
have been added only. Most of these templates
have been made by resuing the structure and
content of previous releases to reduce rework
on part of project teams.
Change-Id: I13f9b7fbb372bd712ee64aed775a2cede771f429
Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
Diffstat (limited to 'docs/templates/release/configguide')
-rw-r--r-- | docs/templates/release/configguide/featureconfig.rst | 32 | ||||
-rw-r--r-- | docs/templates/release/configguide/index.rst | 12 | ||||
-rw-r--r-- | docs/templates/release/configguide/postinstall.rst | 35 |
3 files changed, 79 insertions, 0 deletions
diff --git a/docs/templates/release/configguide/featureconfig.rst b/docs/templates/release/configguide/featureconfig.rst new file mode 100644 index 000000000..8c063f06d --- /dev/null +++ b/docs/templates/release/configguide/featureconfig.rst @@ -0,0 +1,32 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +======================== +<Project> Configuration +======================== +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/templates/release/configguide/index.rst b/docs/templates/release/configguide/index.rst new file mode 100644 index 000000000..9c940eb1a --- /dev/null +++ b/docs/templates/release/configguide/index.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 + +========================================================= +OPNFV <Project Name> Configuration Guide +========================================================= + +.. toctree:: + :maxdepth: 1 + + featureconfig + postinstall diff --git a/docs/templates/release/configguide/postinstall.rst b/docs/templates/release/configguide/postinstall.rst new file mode 100644 index 000000000..51981a124 --- /dev/null +++ b/docs/templates/release/configguide/postinstall.rst @@ -0,0 +1,35 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +======================================= +<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. |