diff options
author | Stuart Mackie <wsmackie@juniper.net> | 2017-09-14 23:26:31 -0700 |
---|---|---|
committer | Stuart Mackie <wsmackie@juniper.net> | 2017-09-14 23:26:31 -0700 |
commit | fd876b7dbc7d517a706b22e52bf6f0e8f79a0b4b (patch) | |
tree | 996858dd4abe0221f8f9d54a2aeeb4ffb9971b8e /docs/development/feature.templates/scenarios/scenario.name | |
parent | fce102283bab73ed08c292fce03e39c52f4a1fe2 (diff) |
Docs
Change-Id: Iea3001f8414267f1535353f28d30d45daf9a3e66
Signed-off-by: Stuart Mackie <wsmackie@juniper.net>
Diffstat (limited to 'docs/development/feature.templates/scenarios/scenario.name')
-rw-r--r-- | docs/development/feature.templates/scenarios/scenario.name/index.rst | 16 | ||||
-rw-r--r-- | docs/development/feature.templates/scenarios/scenario.name/scenario.description.rst | 32 |
2 files changed, 0 insertions, 48 deletions
diff --git a/docs/development/feature.templates/scenarios/scenario.name/index.rst b/docs/development/feature.templates/scenarios/scenario.name/index.rst deleted file mode 100644 index 59ada34..0000000 --- a/docs/development/feature.templates/scenarios/scenario.name/index.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. 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> 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. - -.. toctree:: - :maxdepth: 3 - - ./scenario.description.rst - diff --git a/docs/development/feature.templates/scenarios/scenario.name/scenario.description.rst b/docs/development/feature.templates/scenarios/scenario.name/scenario.description.rst deleted file mode 100644 index afd5879..0000000 --- a/docs/development/feature.templates/scenarios/scenario.name/scenario.description.rst +++ /dev/null @@ -1,32 +0,0 @@ -.. 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 - |