diff options
| author |   Sofia Wallin <sofia.wallin@ericsson.com> | 2017-01-24 19:48:42 +0000 |
|---|---|---|
| committer |   Gerrit Code Review <gerrit@opnfv.org> | 2017-01-24 19:48:42 +0000 |
| commit | 5be018107412af7517893ed6a6a9c65f2f8d183e (patch) | |
| tree | de010c4ceb904601e58a522b2edde75f319c886d /docs/templates/release/scenarios/scenario.name | |
| parent | 7eeb2e7767d243bd16ae160e58eb0326658dd910 (diff) | |
| parent | 9fa0278a6646da9a79a3384c1abf920ece189430 (diff) | |
Merge "Adding all templates under templates/"
Diffstat (limited to 'docs/templates/release/scenarios/scenario.name')
| -rw-r--r-- | docs/templates/release/scenarios/scenario.name/index.rst | 16 | ||||
| -rw-r--r-- | docs/templates/release/scenarios/scenario.name/scenario.description.rst | 42 |
2 files changed, 58 insertions, 0 deletions
diff --git a/docs/templates/release/scenarios/scenario.name/index.rst b/docs/templates/release/scenarios/scenario.name/index.rst new file mode 100644 index 000000000..7487e63bd --- /dev/null +++ b/docs/templates/release/scenarios/scenario.name/index.rst @@ -0,0 +1,16 @@ +.. 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> + +================== +<scenario name> +================== +.. This document will be used to provide a description of the scenario for an end user. +.. You should explain the purpose of the scenario, the types of capabilities provided and +.. the unique components that make up the scenario including how they are used. + +.. toctree:: + :maxdepth: 1 + + scenario.description + 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 + |