From 7d501c4ea14ca3f6294798e010b68395b99aa70b Mon Sep 17 00:00:00 2001 From: Georg Kunz Date: Wed, 15 Feb 2017 11:01:42 +0100 Subject: Adding template framework for Danube documentation Change-Id: I0960f3538163e2609db9a196d665f148967ab454 Signed-off-by: Georg Kunz --- docs/release/configguide/featureconfig.rst | 32 +++++++++++++++++++++++++++ docs/release/configguide/index.rst | 12 ++++++++++ docs/release/configguide/postinstall.rst | 35 ++++++++++++++++++++++++++++++ 3 files changed, 79 insertions(+) create mode 100644 docs/release/configguide/featureconfig.rst create mode 100644 docs/release/configguide/index.rst create mode 100644 docs/release/configguide/postinstall.rst (limited to 'docs/release/configguide') diff --git a/docs/release/configguide/featureconfig.rst b/docs/release/configguide/featureconfig.rst new file mode 100644 index 0000000..005fe9f --- /dev/null +++ b/docs/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 + +====================== +NetReady 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/release/configguide/index.rst b/docs/release/configguide/index.rst new file mode 100644 index 0000000..67f4504 --- /dev/null +++ b/docs/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 NetReady 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..a1a3a2b --- /dev/null +++ b/docs/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 + +==================================== +NetReady 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. + +NetReady 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. -- cgit 1.2.3-korg