docs/templates/release/userguide/feature.userguide.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. (c) <optionally add copywriters name>
   4
   5 ===================================
   6 OPNFV <Project Name> User Guide
   7 ===================================
   8
   9 .. contents::
  10    :depth: 3
  11    :local:
  12
  13 <Feature> description
  14 ------------------------
  15 .. Describe the specific features and how it is realised in the scenario in a brief manner
  16 .. to ensure the user understand the context for the user guide instructions to follow.
  17
  18 <Feature> capabilities and usage
  19 ------------------------------------
  20 .. Describe the specific capabilities and usage for <XYZ> feature.
  21 .. Provide enough information that a user will be able to operate the feature on a deployed scenario.
  22
  23 <Feature and API usage guidelines and example>
  24 -----------------------------------------------
  25 .. Describe with examples how to use specific features, provide API examples and details required to
  26 .. operate the feature on the platform.
  27