summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorChristopherPrice <christopher.price@ericsson.com>2016-08-12 12:02:08 +0000
committerGerrit Code Review <gerrit@172.30.200.206>2016-08-12 12:02:08 +0000
commit6314e937d1e03fe71edc695a0148b5d3e77071ad (patch)
tree8127d54263737883d33eec37e6fe30c2aa74e405 /docs
parent3c352781db97c06468f3910834588ed727ad3725 (diff)
parentd917fdc2eb1a2c98a2503c9f024f3b3a27d8c286 (diff)
Merge "Creating a template for feature projects to produce userguide and scenario description documents"
Diffstat (limited to 'docs')
-rw-r--r--docs/feature.templates/scenarios/scenario.name/index.rst16
-rw-r--r--docs/feature.templates/scenarios/scenario.name/scenario.description.rst32
-rw-r--r--docs/feature.templates/userguide/feature.userguide.rst19
-rw-r--r--docs/feature.templates/userguide/index.rst23
4 files changed, 90 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
+
diff --git a/docs/feature.templates/userguide/feature.userguide.rst b/docs/feature.templates/userguide/feature.userguide.rst
new file mode 100644
index 000000000..b8adfa592
--- /dev/null
+++ b/docs/feature.templates/userguide/feature.userguide.rst
@@ -0,0 +1,19 @@
+.. 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>
+
+<Feature> description
+=====================
+.. Describe the specific features and how it is realised in the scenario in a brief manner
+.. to ensure the user understand the context for the user guide instructions to follow.
+
+<Feature> capabilities and usage
+================================
+.. Describe the specific capabilities and usage for <XYZ> feature.
+.. Provide enough information that a user will be able to operate the feature on a deployed scenario.
+
+<Feature and API usage guidelines and example>
+-----------------------------------------------
+.. Describe with examples how to use specific features, provide API examples and details required to
+.. operate the feature on the platform.
+
diff --git a/docs/feature.templates/userguide/index.rst b/docs/feature.templates/userguide/index.rst
new file mode 100644
index 000000000..cc84670fc
--- /dev/null
+++ b/docs/feature.templates/userguide/index.rst
@@ -0,0 +1,23 @@
+.. 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>
+
+====================
+<feature> user guide
+====================
+
+.. The feature user guide should provide an OPNFV user with enough information to
+.. use the features provided by the feature project in the supported scenarios.
+.. This guide should walk a user through the usage of the features once a scenario
+.. has been deployed and is active according to the installation guide provided
+.. by the installer project.
+
+.. toctree::
+ :maxdepth: 3
+
+.. The feature.userguide.rst file should contain the text for this document
+.. additional documents can be added to this directory and added in the right order
+.. to this file as a list below.
+
+ ./feature.userguide.rst
+