docs/templates/template-install-guide.rst

   1 ############################
   2 <Feature> Installation Guide
   3 ############################
   4
   5 .. note:: *Only* use this template if installation is more complicated
   6           than simply installing a feature in the Karaf distribution.
   7           Otherwise simply provide the names of all user-facing
   8           features in your M3 readout.
   9
  10 This is a template for installing a feature or a project developed in
  11 the ODL project. The *feature* could be interfaces, protocol plug-ins,
  12 or applications.
  13
  14 Overview
  15 ========
  16
  17 Add overview of the feature. Include Architecture diagram and the
  18 positioning of this feature in overall controller architecture.
  19 Highlighting  the feature in a different color within the overall
  20 architecture must help. Include information to describe if the project
  21 is within ODL installation package or to be installed separately.
  22
  23 Pre Requisites for Installing <Feature>
  24 =======================================
  25
  26 * Hardware Requirements
  27 * Software Requirements
  28
  29 Preparing for Installation
  30 ==========================
  31
  32 Include any pre configuration, database, or other software downloads
  33 required to install <feature>.
  34
  35 Installing <Feature>
  36 ====================
  37
  38 Include if you have separate procedures for Windows and Linux
  39
  40 Verifying your Installation
  41 ===========================
  42
  43 Describe how to verify the installation.
  44
  45 Troubleshooting
  46 ===============
  47
  48 *optional*
  49
  50 Text goes here.
  51
  52 Post Installation Configuration
  53 ===============================
  54
  55 Post Installation Configuration section must include some basic
  56 (must-do) procedures if any, to get started.
  57
  58 Mandatory instructions to get started with the product.
  59
  60 * Logging in
  61 * Getting Started
  62 * Integration points with controller
  63
  64 Upgrading From a Previous Release
  65 =================================
  66
  67 Text goes here.
  68
  69 Uninstalling <Feature>
  70 ======================
  71
  72 Text goes here.