summaryrefslogtreecommitdiffstats
path: root/docs/templates/release/userguide
diff options
context:
space:
mode:
authorShubhamRathi <shubhamiiitbackup@gmail.com>2017-01-21 23:01:46 +0530
committerShubhamRathi <shubhamiiitbackup@gmail.com>2017-01-22 22:14:54 +0530
commit9fa0278a6646da9a79a3384c1abf920ece189430 (patch)
treeee5447cbd6ff659213f8978c84a064a7e39cb7ab /docs/templates/release/userguide
parent7b7090d789c1044bd6058b3d33750d0e39cde2e0 (diff)
Adding all templates under templates/
Templates for docs contribution have been added under templates/ .Templates for release/ have been added only. Most of these templates have been made by resuing the structure and content of previous releases to reduce rework on part of project teams. Change-Id: I13f9b7fbb372bd712ee64aed775a2cede771f429 Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
Diffstat (limited to 'docs/templates/release/userguide')
-rw-r--r--docs/templates/release/userguide/feature.userguide.rst27
-rw-r--r--docs/templates/release/userguide/index.rst23
2 files changed, 50 insertions, 0 deletions
diff --git a/docs/templates/release/userguide/feature.userguide.rst b/docs/templates/release/userguide/feature.userguide.rst
new file mode 100644
index 000000000..733c2f99a
--- /dev/null
+++ b/docs/templates/release/userguide/feature.userguide.rst
@@ -0,0 +1,27 @@
+.. 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>
+
+===================================
+OPNFV <Project Name> User Guide
+===================================
+
+.. contents::
+ :depth: 3
+ :local:
+
+<Feature> description
+------------------------
+.. Describe the specific features and how it is realised in the scenario in a brief manner
+.. to ensure the user understand the context for the user guide instructions to follow.
+
+<Feature> capabilities and usage
+------------------------------------
+.. Describe the specific capabilities and usage for <XYZ> feature.
+.. Provide enough information that a user will be able to operate the feature on a deployed scenario.
+
+<Feature and API usage guidelines and example>
+-----------------------------------------------
+.. Describe with examples how to use specific features, provide API examples and details required to
+.. operate the feature on the platform.
+
diff --git a/docs/templates/release/userguide/index.rst b/docs/templates/release/userguide/index.rst
new file mode 100644
index 000000000..5fec00019
--- /dev/null
+++ b/docs/templates/release/userguide/index.rst
@@ -0,0 +1,23 @@
+.. 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> User Guide
+=====================
+
+.. The feature user guide should provide an OPNFV user with enough information to
+.. use the features provided by the feature project in the supported scenarios.
+.. This guide should walk a user through the usage of the features once a scenario
+.. has been deployed and is active according to the installation guide provided
+.. by the installer project.
+
+.. toctree::
+ :maxdepth: 1
+
+ feature.userguide
+.. The feature.userguide.rst file should contain the text for this document
+.. additional documents can be added to this directory and added in the right order
+.. to this file as a list below.
+
+