summaryrefslogtreecommitdiffstats
path: root/docs/development
diff options
context:
space:
mode:
authorDeepak S <deepak.s@linux.intel.com>2017-07-17 09:53:00 +0000
committerGerrit Code Review <gerrit@opnfv.org>2017-07-17 09:53:00 +0000
commit6e83256f8180f44b9e299420f16f2a9f931887ae (patch)
treef9ce530af44f695dfec006a63033beca4b45abf0 /docs/development
parenta0eb3c45ca8a89220caaefa43665a7a1eb6c1933 (diff)
parent272dd80f707564a7b810f46aef31b81994a0e1b4 (diff)
Merge "Documentation Compliance for Euphrates - Adding template"
Diffstat (limited to 'docs/development')
-rw-r--r--docs/development/design/index.rst4
-rw-r--r--docs/development/overview/index.rst15
-rw-r--r--docs/development/overview/overview.rst16
-rw-r--r--docs/development/requirements/index.rst4
4 files changed, 39 insertions, 0 deletions
diff --git a/docs/development/design/index.rst b/docs/development/design/index.rst
new file mode 100644
index 00000000..a2a90560
--- /dev/null
+++ b/docs/development/design/index.rst
@@ -0,0 +1,4 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Intel Corporation and others.
diff --git a/docs/development/overview/index.rst b/docs/development/overview/index.rst
new file mode 100644
index 00000000..284effb7
--- /dev/null
+++ b/docs/development/overview/index.rst
@@ -0,0 +1,15 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Intel Corporation and others.
+
+=============================================
+OPNFV <Project Name> <Release Name> Overview
+=============================================
+
+For example, the title might be "Qtip Danube Overview"
+
+.. toctree::
+ :maxdepth: 1
+
+ overview
diff --git a/docs/development/overview/overview.rst b/docs/development/overview/overview.rst
new file mode 100644
index 00000000..498dc066
--- /dev/null
+++ b/docs/development/overview/overview.rst
@@ -0,0 +1,16 @@
+==============================================
+OPNFV <Release Name> <Project Name> Overview
+==============================================
+
+.. contents::
+ :depth: 3
+ :local:
+
+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
diff --git a/docs/development/requirements/index.rst b/docs/development/requirements/index.rst
new file mode 100644
index 00000000..a2a90560
--- /dev/null
+++ b/docs/development/requirements/index.rst
@@ -0,0 +1,4 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Intel Corporation and others.