summaryrefslogtreecommitdiffstats
path: root/docs/development/Templates
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/development/Templates
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/development/Templates')
-rw-r--r--docs/development/Templates/Design/design.rst0
-rw-r--r--docs/development/Templates/Design/index.rst17
-rw-r--r--docs/development/Templates/Integration/index.rst15
-rw-r--r--docs/development/Templates/Scenario/index.rst15
-rw-r--r--docs/development/Templates/Scenario/scenario.description.rst31
5 files changed, 78 insertions, 0 deletions
diff --git a/docs/development/Templates/Design/design.rst b/docs/development/Templates/Design/design.rst
new file mode 100644
index 000000000..e69de29bb
--- /dev/null
+++ b/docs/development/Templates/Design/design.rst
diff --git a/docs/development/Templates/Design/index.rst b/docs/development/Templates/Design/index.rst
new file mode 100644
index 000000000..817a19440
--- /dev/null
+++ b/docs/development/Templates/Design/index.rst
@@ -0,0 +1,17 @@
+.. 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> Design
+=====================
+
+.. describe which upstream components (e.g. OpenStack modules, ..) are working together to provide the functionality
+.. describe some deployment architecture
+.. fill the gap between the release notes and the detailed documentation provided by the participating projects or upstream communities
+
+.. toctree::
+ :maxdepth: 2
+
+ ./design.rst
+
diff --git a/docs/development/Templates/Integration/index.rst b/docs/development/Templates/Integration/index.rst
new file mode 100644
index 000000000..2e7dd06d3
--- /dev/null
+++ b/docs/development/Templates/Integration/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) <optionally add copywriters name>
+
+======================
+<feature> Integration
+======================
+
+Introduction
+==============
+..Brief on what scenario's the project can be integrated to.
+
+Integration Steps for <>
+===========================
+.. List steps to integrate <project> with <scenario>
diff --git a/docs/development/Templates/Scenario/index.rst b/docs/development/Templates/Scenario/index.rst
new file mode 100644
index 000000000..44605fe7a
--- /dev/null
+++ b/docs/development/Templates/Scenario/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) <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/development/Templates/Scenario/scenario.description.rst b/docs/development/Templates/Scenario/scenario.description.rst
new file mode 100644
index 000000000..36098fd2f
--- /dev/null
+++ b/docs/development/Templates/Scenario/scenario.description.rst
@@ -0,0 +1,31 @@
+.. 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 Danube release, please visit
+http://www.opnfv.org/danube