diff options
| author |   ShubhamRathi <shubhamiiitbackup@gmail.com> | 2017-01-21 23:01:46 +0530 |
|---|---|---|
| committer | ShubhamRathi <shubhamiiitbackup@gmail.com> | 2017-01-22 22:14:54 +0530 |
| commit | 9fa0278a6646da9a79a3384c1abf920ece189430 (patch) | |
| tree | ee5447cbd6ff659213f8978c84a064a7e39cb7ab /docs/templates/release/scenarios/scenario.name/scenario.description.rst | |
| parent | 7b7090d789c1044bd6058b3d33750d0e39cde2e0 (diff) | |
Adding all templates under templates/
Templates for docs contribution have been
added under templates/ .Templates for release/
have been added only. Most of these templates
have been made by resuing the structure and
content of previous releases to reduce rework
on part of project teams.
Change-Id: I13f9b7fbb372bd712ee64aed775a2cede771f429
Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
Diffstat (limited to 'docs/templates/release/scenarios/scenario.name/scenario.description.rst')
| -rw-r--r-- | docs/templates/release/scenarios/scenario.name/scenario.description.rst | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/docs/templates/release/scenarios/scenario.name/scenario.description.rst b/docs/templates/release/scenarios/scenario.name/scenario.description.rst new file mode 100644 index 000000000..9c45b7da4 --- /dev/null +++ b/docs/templates/release/scenarios/scenario.name/scenario.description.rst @@ -0,0 +1,42 @@ +.. 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> + +========================= +OPNFV <Scenario 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 + |