summaryrefslogtreecommitdiffstats
path: root/docs/feature.templates/scenarios
diff options
context:
space:
mode:
authorChristopherPrice <christopher.price@ericsson.com>2016-08-10 11:21:29 +0200
committerChristopherPrice <christopher.price@ericsson.com>2016-08-11 16:04:10 +0200
commitd917fdc2eb1a2c98a2503c9f024f3b3a27d8c286 (patch)
treef77a8d93b126087bf5bc25bd96aa3d21718debcd /docs/feature.templates/scenarios
parentc15e4a979697c71e125e5dd88b0d201744efc39b (diff)
Creating a template for feature projects to produce userguide and scenario description documents
This template will be pushed to features projects in Colorado to help them create the right documentation for the Colorado release. The documentation will be feature and scenario specific at a level where that makes sense while allowing common activities like instalation to be handled in documents for the installation tools. Change-Id: I649c583233ab8d8f8c3ebf7ddf8ae539dae15c8a Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
Diffstat (limited to 'docs/feature.templates/scenarios')
-rw-r--r--docs/feature.templates/scenarios/scenario.name/index.rst16
-rw-r--r--docs/feature.templates/scenarios/scenario.name/scenario.description.rst32
2 files changed, 48 insertions, 0 deletions
diff --git a/docs/feature.templates/scenarios/scenario.name/index.rst b/docs/feature.templates/scenarios/scenario.name/index.rst
new file mode 100644
index 000000000..59ada34e9
--- /dev/null
+++ b/docs/feature.templates/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> 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/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
+