diff options
author | 2017-01-10 18:20:30 +0530 | |
---|---|---|
committer | 2017-01-15 16:26:41 +0000 | |
commit | 326c546133c46a8fa51aee3631cc23d71cacaca4 (patch) | |
tree | 6c62e8e41239e8922b7891d2b3ea879e118050a3 /docs/development/Templates/Scenario/scenario.description.rst | |
parent | 26e52332eb28812b3415aaefc6f53a7637a222fe (diff) |
Add new templates for docs contribution
Adding new templates for docs contribution to be used by the project
teams. Templates for 'Testing/' havent been added yet since its not
perfectly clear what all cases need to be documented.
Change-Id: Id9c1d0d87d99bb071cbcd493817500666cd59b79
Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
Diffstat (limited to 'docs/development/Templates/Scenario/scenario.description.rst')
-rw-r--r-- | docs/development/Templates/Scenario/scenario.description.rst | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/docs/development/Templates/Scenario/scenario.description.rst b/docs/development/Templates/Scenario/scenario.description.rst new file mode 100644 index 000000000..36098fd2f --- /dev/null +++ b/docs/development/Templates/Scenario/scenario.description.rst @@ -0,0 +1,31 @@ +.. 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 Danube release, please visit +http://www.opnfv.org/danube |