summaryrefslogtreecommitdiffstats
path: root/docs/userguide/userguide.rst
diff options
context:
space:
mode:
authorSofia Wallin <sofia.wallin@ericsson.com>2016-01-20 11:10:35 +0100
committerRyota Mibu <r-mibu@cq.jp.nec.com>2016-01-29 05:19:41 +0000
commit0e4bf9ddf7779c7f4f08b5e1f037572107ecae61 (patch)
tree7de94a13803c907dd6846f6e49895f5d96d3fe12 /docs/userguide/userguide.rst
parent5aacaaf9f3fba523264aa7bec7bee5bbc12acdb1 (diff)
Created a template for the User Guide
Please use the userguide.rst to desribce the <Feature> capabilities and usage. This information will be part of the OPNFV user guide. Feel free to use this as a good example, https://gerrit.opnfv.org/gerrit/#/c/7397/ Renamed config-overview.rst to userguide.rst Change-Id: I9e42f1e7fb1cfa52df48642f4cd9a5f283169d1f Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com> (cherry picked from commit 00962469215bd86ccd8aacdcc4324f1fc987b5b7)
Diffstat (limited to 'docs/userguide/userguide.rst')
-rw-r--r--docs/userguide/userguide.rst7
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/userguide/userguide.rst b/docs/userguide/userguide.rst
new file mode 100644
index 00000000..7f3e4f90
--- /dev/null
+++ b/docs/userguide/userguide.rst
@@ -0,0 +1,7 @@
+<Feature> capabilities and usage
+================================
+Describe the specific capabilities and usage for <XYZ> feature.
+
+<Feature and API usage guidelines and example>
+-----------------------------------------------
+Describe with examples how to use specfic features.