summaryrefslogtreecommitdiffstats
path: root/docs/userguide/index.rst
diff options
context:
space:
mode:
authorMaryam Tahhan <maryam.tahhan@intel.com>2016-08-14 12:21:34 +0100
committerMaryam Tahhan <maryam.tahhan@intel.com>2016-08-14 12:46:02 +0100
commit32a7428ae0c68d02db255e42a921445d2d440ff4 (patch)
tree07b3948469feac7afe65fbaca9ebff8e397b9830 /docs/userguide/index.rst
parent87a527a3a62d486e950dbc7a358a4678c0e18b18 (diff)
docs: add userguide
Add a userguide that describes the SFQM features. JIRA: DOCS-106 Change-Id: Icd57e7353bc813ed42fa295dee907b3c67f4fb93 Signed-off-by: Maryam Tahhan <maryam.tahhan@intel.com>
Diffstat (limited to 'docs/userguide/index.rst')
-rw-r--r--docs/userguide/index.rst19
1 files changed, 19 insertions, 0 deletions
diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst
new file mode 100644
index 00000000..994f63c8
--- /dev/null
+++ b/docs/userguide/index.rst
@@ -0,0 +1,19 @@
+.. 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>
+
+====================
+SFQM 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
+
+ collectd.userguide.rst
+ keepalive.userguide.rst