template for installation guide

Change-Id: Ie5f0fa80b23ce7ed1e3184c216be81294fb26ca8
Signed-off-by: Divya Shetty <dshetty@brocade.com>

diff --git a/manuals/readme/src/main/asciidoc/readme.adoc b/manuals/readme/src/main/asciidoc/readme.adoc
index 8fa57fc873f64257a54babf50522b1ea991f37fb..e1e1d5eccf75a234e6c2bc8ca85eb460dedc5e0d 100644 (file)
--- a/manuals/readme/src/main/asciidoc/readme.adoc
+++ b/manuals/readme/src/main/asciidoc/readme.adoc
@@ -8,4 +8,6 @@ This document is here to give example templates for OpenDaylight
 projects to create their own documentation. It is not intended to be
 part of the shipping OpenDaylight documentation.
 
+include::template_installation_guide.adoc[Installation Guide Template]
+
 include::template_release_notes.adoc[Release Notes Template]

diff --git a/manuals/readme/src/main/asciidoc/template_installation_guide.adoc b/manuals/readme/src/main/asciidoc/template_installation_guide.adoc
new file mode 100644 (file)
index 0000000..cb16f62
--- /dev/null
+++ b/manuals/readme/src/main/asciidoc/template_installation_guide.adoc
@@ -0,0 +1,48 @@
+== <Feature> Installation Guide
+NOTE: *Only* use this template if installation is more complicated than
+simply installing a feature in the Karaf distribution. Otherwise simply
+provide the names of all user-facing features in your M3 readout.
+
+This is a template for installing a feature or a project developed in
+the ODL project. The *feature* could be interfaces, protocol plug-ins,
+or applications.
+
+=== Overview
+Add overview of the feature. Include Architecture diagram and the
+positioning of this feature in overall controller architecture.
+Highlighting  the feature in a different color within the overall
+architecture must help. Include information to describe if the project
+is within ODL installation package or to be installed separately.
+
+=== Pre Requisites for Installing <Feature>
+* Hardware Requirements
+* Software Requirements
+
+=== Preparing for Installation
+Include any pre configuration, database, or other software downloads
+required to install <feature>.
+
+=== Installing <Feature>
+Include if you have separate procedures for Windows and Linux
+
+=== Verifying your Installation
+Describe how to verify the installation.
+
+==== Troubleshooting
+<optional>
+Text goes here.
+
+=== Post Installation Configuration
+Post Installation Configuration section must include some basic
+(must-do) procedures if any, to get started.
+
+Mandatory instructions to get started with the product.
+* Logging in
+* Getting Started
+* Integration points with controller
+
+=== Upgrading From a Previous Release
+Text goes here.
+
+=== Uninstalling <Feature>
+Text goes here.