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>

diff --git a/docs/index.rst b/docs/index.rst
index d9d557f..5f0aae4 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -25,4 +25,5 @@ Table of Contents:
      :numbered:
 
      requirements/index.rst
+     userguide/index.rst
      release/index.rst

diff --git a/docs/requirements/index.rst b/docs/requirements/index.rst
index a58b103..a9be153 100644 (file)
--- a/docs/requirements/index.rst
+++ b/docs/requirements/index.rst
@@ -7,6 +7,3 @@
      :numbered:
 
      01-intro.rst
-     02-measuring_telco_traffic_and_performance_KPIs.rst
-     03-dpdk_ka.rst
-     04-release_b.rst

diff --git a/docs/requirements/02-measuring_telco_traffic_and_performance_KPIs.rst b/docs/userguide/collectd.userguide.rst
similarity index 94%
rename from docs/requirements/02-measuring_telco_traffic_and_performance_KPIs.rst
rename to docs/userguide/collectd.userguide.rst
index 7f0d486..0755fdf 100644 (file)
--- a/docs/requirements/02-measuring_telco_traffic_and_performance_KPIs.rst
+++ b/docs/userguide/collectd.userguide.rst
@@ -2,8 +2,15 @@
 .. http://creativecommons.org/licenses/by/4.0
 .. (c) OPNFV, Intel Corporation and others.
 
+collectd plugins description
+============================
+The SFQM collectd plugins enable the ability to monitor DPDK interfaces by
+exposing stats and the relevant events to higher level telemetry and fault
+management applications. The following sections will discuss the SFQM features
+in detail.
+
 Measuring Telco Traffic and Performance KPIs
-============================================
+--------------------------------------------
 This section will discuss the SFQM features that enable Measuring Telco Traffic
 and Performance KPIs.
 
@@ -32,7 +39,7 @@ and Performance KPIs.
     value pairs, improving the overall performance of the API.
 
 Monitoring DPDK interfaces
-===========================
+--------------------------
 With the features SFQM enabled in DPDK to enable measuring Telco traffic and
 performance KPIs, we can now retrieve NIC statistics including error stats and
 relay them to a DPDK user. The next step is to enable monitoring of the DPDK
@@ -41,7 +48,7 @@ the information to a higher level Fault Management entity. To enable this SFQM
 has been enabling a number of plugins for collectd.
 
 collectd
----------
+~~~~~~~~
 collectd is a daemon which collects system performance statistics periodically
 and provides a variety of mechanisms to publish the collected metrics. It
 supports more than 90 different input and output plugins. Input plugins retrieve
@@ -49,8 +56,8 @@ metrics and publish them to the collectd deamon, while output plugins publish
 the data they receive to an end point. collectd also has infrastructure to
 support thresholding and notification.
 
-Statistics and Notifications
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+collectd statistics and Notifications
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Within collectd notifications and performance data are dispatched in the same
 way. There are producer plugins (plugins that create notifications/metrics),
 and consumer plugins (plugins that receive notifications/metrics and do

diff --git a/docs/requirements/dpdk_ka.png b/docs/userguide/dpdk_ka.png
similarity index 100%
rename from docs/requirements/dpdk_ka.png
rename to docs/userguide/dpdk_ka.png

diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst
new file mode 100644 (file)
index 0000000..994f63c
--- /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

diff --git a/docs/requirements/03-dpdk_ka.rst b/docs/userguide/keepalive.userguide.rst
similarity index 97%
rename from docs/requirements/03-dpdk_ka.rst
rename to docs/userguide/keepalive.userguide.rst
index ce3e7e4..4b6e990 100644 (file)
--- a/docs/requirements/03-dpdk_ka.rst
+++ b/docs/userguide/keepalive.userguide.rst
@@ -2,8 +2,8 @@
 .. http://creativecommons.org/licenses/by/4.0
 .. (c) OPNFV, Intel Corporation and others.
 
-DPDK Keep Alive Overview
-=========================
+DPDK Keep Alive description
+===========================
 SFQM aims to enable fault detection within DPDK, the very first feature to
 meet this goal is the DPDK Keep Alive Sample app that is part of DPDK 2.2.
 
@@ -29,7 +29,7 @@ detection and notification.
   heartbeat mechanism.
 
 DPDK Keep Alive Sample App Internals
-====================================
+------------------------------------
 This section provides some explanation of the The Keep-Alive/'Liveliness'
 conceptual scheme as well as the DPDK Keep Alive App. The initialization and
 run-time paths are very similar to those of the L2 forwarding application (see
@@ -51,7 +51,7 @@ The Keep-Alive/'Liveliness' conceptual scheme is:
 to monitor the Keep Alive Monitor Agent Core.
 
 DPDK Keep Alive Sample App Code Internals
-=========================================
+-----------------------------------------
 The following section provides some explanation of the code aspects that are
 specific to the Keep Alive sample application.
 

diff --git a/docs/requirements/monitoring_interfaces.png b/docs/userguide/monitoring_interfaces.png
similarity index 100%
rename from docs/requirements/monitoring_interfaces.png
rename to docs/userguide/monitoring_interfaces.png

diff --git a/docs/requirements/stats_and_timestamps.png b/docs/userguide/stats_and_timestamps.png
similarity index 100%
rename from docs/requirements/stats_and_timestamps.png
rename to docs/userguide/stats_and_timestamps.png