summaryrefslogtreecommitdiffstats
path: root/docs/release/Templates/Overview
diff options
context:
space:
mode:
authorShubhamRathi <shubhamiiitbackup@gmail.com>2017-01-10 18:20:30 +0530
committerChristopher Price <christopher.price@ericsson.com>2017-01-15 16:26:41 +0000
commit326c546133c46a8fa51aee3631cc23d71cacaca4 (patch)
tree6c62e8e41239e8922b7891d2b3ea879e118050a3 /docs/release/Templates/Overview
parent26e52332eb28812b3415aaefc6f53a7637a222fe (diff)
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>
Diffstat (limited to 'docs/release/Templates/Overview')
-rw-r--r--docs/release/Templates/Overview/index.rst18
-rw-r--r--docs/release/Templates/Overview/overview.rst13
2 files changed, 31 insertions, 0 deletions
diff --git a/docs/release/Templates/Overview/index.rst b/docs/release/Templates/Overview/index.rst
new file mode 100644
index 000000000..18e1dbd9d
--- /dev/null
+++ b/docs/release/Templates/Overview/index.rst
@@ -0,0 +1,18 @@
+.. 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.
+
+=============================================
+<Project Name> <Release Name> Overview
+=============================================
+
+For example, the title might be "Qtip Danube Overview"
+
+<Brief (Optional)>
+===================
+
+.. toctree::
+ :maxdepth: 2
+
+ overview
diff --git a/docs/release/Templates/Overview/overview.rst b/docs/release/Templates/Overview/overview.rst
new file mode 100644
index 000000000..163cdd3e0
--- /dev/null
+++ b/docs/release/Templates/Overview/overview.rst
@@ -0,0 +1,13 @@
+==============================================
+<Project Name> <Release Name> Overview
+==============================================
+
+
+Introduction
+=======================================
+Describing the components and behaviours in a manner that helps people understand the platform and how to work with it
+
+Upgrades from <Previous Release>
+=====================================
+<optional, required if there's a previous release for the project>
+Describe the new features \ No newline at end of file