Merge "Initial release documents"

5 files changed, 108 insertions, 0 deletions

diff --git a/docs/configguide/featureconfig.rst b/docs/configguide/featureconfig.rst
new file mode 100644
index 0000000..188ee55
--- /dev/null
+++ b/docs/configguide/featureconfig.rst
@@ -0,0 +1,28 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) <optionally add copywriters name>
+
+Parser 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...)
diff --git a/docs/configguide/installerconfig.rst b/docs/configguide/installerconfig.rst
new file mode 100644
index 0000000..ddc7bea
--- /dev/null
+++ b/docs/configguide/installerconfig.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) <optionally add copywriters name>
+
+Parser configuration
+=====================
+Add a brief introduction to configure OPNFV with this specific installer
+
+Pre-configuration activities
+-----------------------------
+Describe specific pre-configuration activities. Refer to Installations guide and release notes
+
+Hardware configuration
+-----------------------
+Describe the hardware configuration needed for this specific installer
+
+Jumphost configuration
+-----------------------
+Describe intial Jumphost configuration (network and software)needed in order to deploy the installer
+
+Platform components configuration
+---------------------------------
+Describe the configuration of each component in the installer
+
+
+
diff --git a/docs/configguide/postinstall.rst b/docs/configguide/postinstall.rst
new file mode 100644
index 0000000..252bff6
--- /dev/null
+++ b/docs/configguide/postinstall.rst
@@ -0,0 +1,30 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) <optionally add copywriters name>
+
+Parser post installation procedures
+====================================
+Add a brief introduction to the methods of validating the installation
+according to this specific installer or feature.
+
+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.
+
+Parser 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/userguide/featureusage.rst b/docs/userguide/featureusage.rst
new file mode 100644
index 0000000..f133134
--- /dev/null
+++ b/docs/userguide/featureusage.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) <optionally add copywriters name>
+
+<Feature> capabilities and usage
+================================
+Describe the specific capabilities and usage for <XYZ> feature.
+
+<Feature and API usage guidelines and example>
+-----------------------------------------------
+Describe with examples how to use specfic features.
+
diff --git a/docs/userguide/testusage.rst b/docs/userguide/testusage.rst
new file mode 100644
index 0000000..9f9bdc9
--- /dev/null
+++ b/docs/userguide/testusage.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) <optionally add copywriters name>
+
+<Testing> capabilities and usage
+================================
+Describe the specific capabilities and usage for <XYZ> testing.
+
+<Testing usage guidelines and example>
+--------------------------------------
+Describe with examples how to use specfic test frameworks.
+