summaryrefslogtreecommitdiffstats
path: root/docs/release/templates/releasenotes/scenario
diff options
context:
space:
mode:
authorSofia Wallin <sofia.wallin@ericsson.com>2017-01-16 16:12:13 +0100
committerSofia Wallin <sofia.wallin@ericsson.com>2017-01-16 16:12:13 +0100
commit7881a0541c8b40663bba4aa3a5efdf9f3421e58f (patch)
treea48944226bf71a4a93d386d348a1ac6ca42a643a /docs/release/templates/releasenotes/scenario
parent2e90847bdc1ef9ce49eb4c3424690fbb3460818f (diff)
Adjusted naming path
Adjusted the naming path for consistency throughout our repository and the community. Change-Id: Ia055c418584f338f6000835fc28a7e5e8b5c5818 Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
Diffstat (limited to 'docs/release/templates/releasenotes/scenario')
-rw-r--r--docs/release/templates/releasenotes/scenario/<scenarioname>.rst37
-rw-r--r--docs/release/templates/releasenotes/scenario/index.rst16
2 files changed, 53 insertions, 0 deletions
diff --git a/docs/release/templates/releasenotes/scenario/<scenarioname>.rst b/docs/release/templates/releasenotes/scenario/<scenarioname>.rst
new file mode 100644
index 000000000..47c85ec15
--- /dev/null
+++ b/docs/release/templates/releasenotes/scenario/<scenarioname>.rst
@@ -0,0 +1,37 @@
+.. 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> <Release Name> Release Notes
+=============================================
+
+
+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 \ No newline at end of file
diff --git a/docs/release/templates/releasenotes/scenario/index.rst b/docs/release/templates/releasenotes/scenario/index.rst
new file mode 100644
index 000000000..7a2cf9bb1
--- /dev/null
+++ b/docs/release/templates/releasenotes/scenario/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) OPNFV, Ericsson AB and others.
+
+=============================================
+<Release Name> Scenario Release Notes
+=============================================
+
+<Brief (Optional)>
+===================
+
+.. toctree::
+ :maxdepth: 2
+
+ <scenarioname>