From a8220ab2d293bb7f4b014b79d16b2fb05090fa93 Mon Sep 17 00:00:00 2001
From: Daniel Baumann <daniel.baumann@progress-linux.org>
Date: Sun, 7 Feb 2021 12:45:55 +0100
Subject: Adding upstream version 1.29.0.

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
---
 collectors/python.d.plugin/megacli/README.md | 47 +++++++++++++++++-----------
 1 file changed, 29 insertions(+), 18 deletions(-)

(limited to 'collectors/python.d.plugin/megacli/README.md')

diff --git a/collectors/python.d.plugin/megacli/README.md b/collectors/python.d.plugin/megacli/README.md
index afc8cbda6..400a45973 100644
--- a/collectors/python.d.plugin/megacli/README.md
+++ b/collectors/python.d.plugin/megacli/README.md
@@ -1,12 +1,25 @@
-# megacli
+<!--
+title: "MegaRAID controller monitoring with Netdata"
+custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/megacli/README.md
+sidebar_label: "MegaRAID controllers"
+-->
 
-Module collects adapter, physical drives and battery stats.
+# MegaRAID controller monitoring with Netdata
 
-**Requirements:**
+Collects adapter, physical drives and battery stats.
+
+## Requirements
+
+Uses the `megacli` program, which can only be executed by root.  It uses
+`sudo` and assumes that it is configured such that the `netdata` user can
+execute `megacli` as root without password.
+
+Add to `sudoers`:
+
+```
+netdata ALL=(root)       NOPASSWD: /path/to/megacli
+```
 
--   `megacli` program
--   `sudo` program
--   `netdata` user needs to be able to be able to sudo the `megacli` program without password
 
 To grab stats it executes:
 
@@ -25,19 +38,9 @@ It produces:
 
 5.  **Battery Cycle Count**
 
-## prerequisite
 
-This module uses `megacli` which can only be executed by root.  It uses
-`sudo` and assumes that it is configured such that the `netdata` user can
-execute `megacli` as root without password.
-
-Add to `sudoers`:
-
-```
-netdata ALL=(root)       NOPASSWD: /path/to/megacli
-```
 
-### configuration
+## Configuration
 
 **megacli** is disabled by default. Should be explicitly enabled in `python.d.conf`.
 
@@ -45,7 +48,15 @@ netdata ALL=(root)       NOPASSWD: /path/to/megacli
 megacli: yes
 ```
 
-Battery stats disabled by default. To enable them modify `megacli.conf`.
+Edit the `python.d/megacli.conf` configuration file using `edit-config` from the Netdata [config
+directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
+
+```bash
+cd /etc/netdata   # Replace this path with your Netdata config directory, if different
+sudo ./edit-config python.d/megacli.conf
+```
+
+Battery stats disabled by default. To enable them, modify `megacli.conf`.
 
 ```yaml
 do_battery: yes
-- 
cgit v1.2.3