diff options
| author |   Maryam Tahhan <maryam.tahhan@intel.com> | 2016-12-13 10:27:47 +0000 |
|---|---|---|
| committer | Maryam Tahhan <maryam.tahhan@intel.com> | 2016-12-13 10:37:23 +0000 |
| commit | 199077e6ca9b2a6fe23cf1b2baa99cb5a82aa1ec (patch) | |
| tree | 0fa6120ca2c4e03c15dd91cf12dc30ee5383cf14 /docs/userguide | |
| parent | 0c1d10389d86c1e6c5cb33552baf58840529406b (diff) | |
docs: cleanup and reduce toc tree size
Change-Id: I94d0e7ee880d5cc79743ce0703287b50152af71d
Signed-off-by: Maryam Tahhan <maryam.tahhan@intel.com>
Diffstat (limited to 'docs/userguide')
| -rw-r--r-- | docs/userguide/collectd.userguide.rst | 8 | ||||
| -rw-r--r-- | docs/userguide/index.rst | 4 |
2 files changed, 10 insertions, 2 deletions
diff --git a/docs/userguide/collectd.userguide.rst b/docs/userguide/collectd.userguide.rst index cbe87a09..2dcb3593 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 @@ -272,8 +278,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. |