diff options
Diffstat (limited to 'docs/templates/release/scenarios')
| -rw-r--r-- | docs/templates/release/scenarios/scenario.name/index.rst | 6 | ||||
| -rw-r--r-- | docs/templates/release/scenarios/scenario.name/scenario.description.rst | 15 |
2 files changed, 9 insertions, 12 deletions
diff --git a/docs/templates/release/scenarios/scenario.name/index.rst b/docs/templates/release/scenarios/scenario.name/index.rst index 7487e63bd..37aab8458 100644 --- a/docs/templates/release/scenarios/scenario.name/index.rst +++ b/docs/templates/release/scenarios/scenario.name/index.rst @@ -2,9 +2,9 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) <optionally add copywriters name> -================== -<scenario name> -================== +**************************************** +<scenario name> overview and description +**************************************** .. 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. diff --git a/docs/templates/release/scenarios/scenario.name/scenario.description.rst b/docs/templates/release/scenarios/scenario.name/scenario.description.rst index 9c45b7da4..8c2cbabd1 100644 --- a/docs/templates/release/scenarios/scenario.name/scenario.description.rst +++ b/docs/templates/release/scenarios/scenario.name/scenario.description.rst @@ -2,40 +2,37 @@ .. 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 |