diff options
| author |   cristinapauna <cristina.pauna@enea.com> | 2019-03-10 09:01:41 +0200 |
|---|---|---|
| committer |   weichen <niweichen@chinamobile.com> | 2019-03-28 12:12:57 +0800 |
| commit | 19d12b2624d8d85edbc7d74e02002e2d95abc764 (patch) | |
| tree | 8228b1126a5e474310afca56aecbe106d92db908 /docs/release/scenarios/scenario.name | |
| parent | 31560e9a26e6a7e2e65d18924c938ee7a7683fb3 (diff) | |
add cran docs directories
Change-Id: I212ff0750514d81571bc9cbd533ab1276600c2b1
Signed-off-by: weichen <niweichen@chinamobile.com>
Diffstat (limited to 'docs/release/scenarios/scenario.name')
| -rw-r--r-- | docs/release/scenarios/scenario.name/index.rst | 16 | ||||
| -rw-r--r-- | docs/release/scenarios/scenario.name/scenario.description.rst | 39 |
2 files changed, 55 insertions, 0 deletions
diff --git a/docs/release/scenarios/scenario.name/index.rst b/docs/release/scenarios/scenario.name/index.rst new file mode 100644 index 0000000..a424358 --- /dev/null +++ b/docs/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> 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: 1
+
+ scenario.description
+
diff --git a/docs/release/scenarios/scenario.name/scenario.description.rst b/docs/release/scenarios/scenario.name/scenario.description.rst new file mode 100644 index 0000000..858a569 --- /dev/null +++ b/docs/release/scenarios/scenario.name/scenario.description.rst @@ -0,0 +1,39 @@ +.. 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>
+
+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
+
|