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