From 326c546133c46a8fa51aee3631cc23d71cacaca4 Mon Sep 17 00:00:00 2001
From: ShubhamRathi <shubhamiiitbackup@gmail.com>
Date: Tue, 10 Jan 2017 18:20:30 +0530
Subject: Add new templates for docs contribution

Adding new templates for docs contribution to be used by the project
teams. Templates for 'Testing/' havent been added yet since its not
perfectly clear what all cases need to be documented.

Change-Id: Id9c1d0d87d99bb071cbcd493817500666cd59b79
Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
---
 .../ReleaseNotes/scenario/<scenarioname>.rst       | 37 ++++++++++++++++++++++
 .../Templates/ReleaseNotes/scenario/index.rst      | 16 ++++++++++
 2 files changed, 53 insertions(+)
 create mode 100644 docs/release/Templates/ReleaseNotes/scenario/<scenarioname>.rst
 create mode 100644 docs/release/Templates/ReleaseNotes/scenario/index.rst

(limited to 'docs/release/Templates/ReleaseNotes/scenario')

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>
-- 
cgit 1.2.3-korg