summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/configguide/feature.configuration.rst (renamed from docs/configguide/featureconfig.rst)0
-rw-r--r--docs/configguide/index.rst6
-rw-r--r--docs/index.rst14
-rw-r--r--docs/release/index.rst5
-rw-r--r--docs/requirements/index.rst5
-rw-r--r--docs/userguide/collectd.userguide.rst8
-rw-r--r--docs/userguide/index.rst4
7 files changed, 31 insertions, 11 deletions
diff --git a/docs/configguide/featureconfig.rst b/docs/configguide/feature.configuration.rst
index e7c8d5ce..e7c8d5ce 100644
--- a/docs/configguide/featureconfig.rst
+++ b/docs/configguide/feature.configuration.rst
diff --git a/docs/configguide/index.rst b/docs/configguide/index.rst
index d97583c2..b336d2d5 100644
--- a/docs/configguide/index.rst
+++ b/docs/configguide/index.rst
@@ -2,8 +2,12 @@
.. http://creativecommons.org/licenses/by/4.0
.. Copyright (c) 2016 Open Platform for NFV Project, Inc. and its contributors
+***************************************
+Barometer configuration Guide in OPNFV
+***************************************
+
.. toctree::
:numbered:
:maxdepth: 3
- featureconfig.rst
+ feature.configuration.rst
diff --git a/docs/index.rst b/docs/index.rst
index a6d3b939..9b1c6137 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -7,7 +7,9 @@ Barometer
=========
:Project: Barometer, https://wiki.opnfv.org/display/fastpath/Barometer+Home
+
:Authors: Maryam Tahhan <maryam.tahhan@intel.com>
+
:History:
========== =====================================================
@@ -16,15 +18,15 @@ Barometer
16.12.2014 Project creation
========== =====================================================
-
-Table of Contents:
-==================
-
.. toctree::
- :maxdepth: 4
+ :maxdepth: 3
:numbered:
./requirements/index.rst
- ./configguide/index.rst
./userguide/index.rst
+ ./configguide/index.rst
./release/index.rst
+
+Indices
+=======
+* :ref:`search`
diff --git a/docs/release/index.rst b/docs/release/index.rst
index 706efe7f..30b2524c 100644
--- a/docs/release/index.rst
+++ b/docs/release/index.rst
@@ -2,8 +2,11 @@
.. http://creativecommons.org/licenses/by/4.0
.. (c) OPNFV, Intel Corporation and others.
+************************
+Barometer Release Notes
+************************
.. toctree::
- :maxdepth: 4
+ :maxdepth: 3
:numbered:
01-release.rst
diff --git a/docs/requirements/index.rst b/docs/requirements/index.rst
index b36f4513..e5d04896 100644
--- a/docs/requirements/index.rst
+++ b/docs/requirements/index.rst
@@ -2,8 +2,11 @@
.. http://creativecommons.org/licenses/by/4.0
.. (c) OPNFV, Intel Corporation and others.
+**********************
+Barometer Requirements
+**********************
.. toctree::
- :maxdepth: 4
+ :maxdepth: 3
:numbered:
01-intro.rst
diff --git a/docs/userguide/collectd.userguide.rst b/docs/userguide/collectd.userguide.rst
index bb625f82..ea09bb1a 100644
--- a/docs/userguide/collectd.userguide.rst
+++ b/docs/userguide/collectd.userguide.rst
@@ -89,7 +89,9 @@ Please note if you are using any Open vSwitch plugins you need to run:
DPDK statistics plugin
-----------------------
Repo: https://github.com/collectd/collectd
+
Branch: master
+
Dependencies: DPDK (http://dpdk.org/)
To build and install DPDK to /usr please see:
@@ -153,7 +155,9 @@ reboot). Pending a merge of https://github.com/collectd/collectd/pull/2073.
Hugepages Plugin
-----------------
Repo: https://github.com/collectd/collectd
+
Branch: master
+
Dependencies: None, but assumes hugepages are configured.
To configure some hugepages:
@@ -197,7 +201,9 @@ https://github.com/collectd/collectd/blob/master/src/collectd.conf.pod
Intel RDT Plugin
-----------------
Repo: https://github.com/collectd/collectd
+
Branch: master
+
Dependencies:
* PQoS/Intel RDT library https://github.com/01org/intel-cmt-cat.git
@@ -490,8 +496,10 @@ Reload
Additional useful plugins
--------------------------
+
Exec Plugin
~~~~~~~~~~~
+
Can be used to show you when notifications are being generated by calling a
bash script that dumps notifications to file. (handy for debug). Modify
/opt/collectd/etc/collectd.conf:
diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst
index 5f019181..bf62a43d 100644
--- a/docs/userguide/index.rst
+++ b/docs/userguide/index.rst
@@ -2,9 +2,9 @@
.. http://creativecommons.org/licenses/by/4.0
.. (c) Intel Corporation and OPNFV
-====================
+********************
Barometer 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.