summaryrefslogtreecommitdiffstats
path: root/docs/feature.templates/userguide/index.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/feature.templates/userguide/index.rst')
-rw-r--r--docs/feature.templates/userguide/index.rst23
1 files changed, 23 insertions, 0 deletions
diff --git a/docs/feature.templates/userguide/index.rst b/docs/feature.templates/userguide/index.rst
new file mode 100644
index 000000000..cc84670fc
--- /dev/null
+++ b/docs/feature.templates/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: 3
+
+.. 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.
+
+ ./feature.userguide.rst
+