summaryrefslogtreecommitdiffstats
path: root/docs/templates/release/scenarios/scenario.name/scenario.description.rst
blob: 8c2cbabd116b7f2aaee558b6104e5b4c65f039c0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. (c) <optionally add copywriters name>

This document provides scenario level details for <RELEASE> of <COMPONENT>.

.. contents::
   :depth: 3
   :local:

============
Introduction
============
.. In this section explain the purpose of the scenario and the types of capabilities provided

Scenario components and composition
===================================
.. In this section describe the unique components that make up the scenario,
.. what each component provides and why it has been included in order
.. to communicate to the user the capabilities available in this scenario.

Scenario usage overview
=======================
.. Provide a brief overview on how to use the scenario and the features available to the
.. user.  This should be an "introduction" to the userguide document, and explicitly link to it,
.. where the specifics of the features are covered including examples and API's

Limitations, Issues and Workarounds
===================================
.. Explain scenario limitations here, this should be at a design level rather than discussing
.. faults or bugs.  If the system design only provide some expected functionality then provide
.. some insight at this point.

References
==========

For more information on the OPNFV Danube release, please visit
http://www.opnfv.org/danube