diff options
| author |   ChristopherPrice <christopher.price@ericsson.com> | 2016-08-12 12:02:08 +0000 |
|---|---|---|
| committer |   Gerrit Code Review <gerrit@172.30.200.206> | 2016-08-12 12:02:08 +0000 |
| commit | 6314e937d1e03fe71edc695a0148b5d3e77071ad (patch) | |
| tree | 8127d54263737883d33eec37e6fe30c2aa74e405 /docs/feature.templates/scenarios/scenario.name/scenario.description.rst | |
| parent | 3c352781db97c06468f3910834588ed727ad3725 (diff) | |
| parent | d917fdc2eb1a2c98a2503c9f024f3b3a27d8c286 (diff) | |
Merge "Creating a template for feature projects to produce userguide and scenario description documents"
Diffstat (limited to 'docs/feature.templates/scenarios/scenario.name/scenario.description.rst')
| -rw-r--r-- | docs/feature.templates/scenarios/scenario.name/scenario.description.rst | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/docs/feature.templates/scenarios/scenario.name/scenario.description.rst b/docs/feature.templates/scenarios/scenario.name/scenario.description.rst new file mode 100644 index 000000000..afd587915 --- /dev/null +++ b/docs/feature.templates/scenarios/scenario.name/scenario.description.rst @@ -0,0 +1,32 @@ +.. 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> + +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 Colorado release, please visit +http://www.opnfv.org/colorado + |