summaryrefslogtreecommitdiffstats
path: root/docs/configguide/featureconfig.rst
diff options
context:
space:
mode:
authorChristopherPrice <christopher.price@ericsson.com>2016-01-05 11:02:46 +0100
committerChristopherPrice <christopher.price@ericsson.com>2016-01-05 15:16:21 +0100
commit1333804ddb62a9d501c906a480c4d86e7fc690a0 (patch)
tree9a6a093d5cafce63a7e7a7931be8243b040e40c4 /docs/configguide/featureconfig.rst
parent522f1f294b964f004bf1225f63e5d6583158913c (diff)
Adding template files for the configguide composite document
Added the feature configuration and post install/config template files for use in the composite configguide document. Fixed trailing whitespace, and added ./ specificity to the local doc references. Change-Id: I7778993d01d978b60d46375b334d59dbdc2b855a Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
Diffstat (limited to 'docs/configguide/featureconfig.rst')
-rw-r--r--docs/configguide/featureconfig.rst24
1 files changed, 24 insertions, 0 deletions
diff --git a/docs/configguide/featureconfig.rst b/docs/configguide/featureconfig.rst
new file mode 100644
index 000000000..9189902c6
--- /dev/null
+++ b/docs/configguide/featureconfig.rst
@@ -0,0 +1,24 @@
+<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.
+
+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...)