docs/development/Templates/Scenario/scenario.description.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 Introduction
   6 ============
   7 .. In this section explain the purpose of the scenario and the types of capabilities provided
   8
   9 Scenario components and composition
  10 ===================================
  11 .. In this section describe the unique components that make up the scenario,
  12 .. what each component provides and why it has been included in order
  13 .. to communicate to the user the capabilities available in this scenario.
  14
  15 Scenario usage overview
  16 =======================
  17 .. Provide a brief overview on how to use the scenario and the features available to the
  18 .. user.  This should be an "introduction" to the userguide document, and explicitly link to it,
  19 .. where the specifics of the features are covered including examples and API's
  20
  21 Limitations, Issues and Workarounds
  22 ===================================
  23 .. Explain scenario limitations here, this should be at a design level rather than discussing
  24 .. faults or bugs.  If the system design only provide some expected functionality then provide
  25 .. some insight at this point.
  26
  27 References
  28 ==========
  29
  30 For more information on the OPNFV Danube release, please visit
  31 http://www.opnfv.org/danube