From 81581f9719bc56f01d5aa08952671d65fda9867a Mon Sep 17 00:00:00 2001
From: Daniel Baumann <daniel.baumann@progress-linux.org>
Date: Mon, 8 May 2023 18:27:08 +0200
Subject: Merging upstream version 1.39.0.

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
---
 collectors/charts.d.plugin/sensors/README.md | 36 +++++++++++++---------------
 1 file changed, 16 insertions(+), 20 deletions(-)

(limited to 'collectors/charts.d.plugin/sensors/README.md')

diff --git a/collectors/charts.d.plugin/sensors/README.md b/collectors/charts.d.plugin/sensors/README.md
index 142ae14aa..2601a2b65 100644
--- a/collectors/charts.d.plugin/sensors/README.md
+++ b/collectors/charts.d.plugin/sensors/README.md
@@ -1,16 +1,7 @@
-<!--
-title: "Linux machine sensors monitoring with Netdata"
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/charts.d.plugin/sensors/README.md"
-sidebar_label: "lm-sensors"
-learn_status: "Published"
-learn_topic_type: "References"
-learn_rel_path: "References/Collectors references/Devices"
--->
-
-# Linux machine sensors monitoring with Netdata
-
-Use this collector when `lm-sensors` doesn't work on your device (e.g. for RPi temperatures). 
-For all other cases use the [Python collector](/collectors/python.d.plugin/sensors), which supports multiple 
+# Linux machine sensors collector
+
+Use this collector when `lm-sensors` doesn't work on your device (e.g. for RPi temperatures).
+For all other cases use the [Python collector](https://github.com/netdata/netdata/blob/master/collectors/python.d.plugin/sensors), which supports multiple
 jobs, is more efficient and performs calculations on top of the kernel provided values.
 
 This plugin will provide charts for all configured system sensors, by reading sensors directly from the kernel.
@@ -30,15 +21,23 @@ One chart for every sensor chip found and each of the above will be created.
 
 ## Enable the collector
 
-The `sensors` collector is disabled by default. To enable it, edit the `charts.d.conf` file using `edit-config` from the
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is typically at `/etc/netdata`.
+The `sensors` collector is disabled by default.
+
+To enable the collector, you need to edit the configuration file of `charts.d/sensors.conf`. You can do so by using the `edit config` script.  
+
+> ### Info
+>
+> To edit configuration files in a safe way, we provide the [`edit config` script](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#use-edit-config-to-edit-configuration-files) located in your [Netdata config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#the-netdata-config-directory) (typically is `/etc/netdata`) that creates the proper file and opens it in an editor automatically.  
+> It is recommended to use this way for configuring Netdata.
+>
+> Please also note that after most configuration changes you will need to [restart the Agent](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) for the changes to take effect.
 
 ```bash
 cd /etc/netdata   # Replace this path with your Netdata config directory, if different
 sudo ./edit-config charts.d.conf
 ```
 
-It also needs to be set to "force" to be enabled:
+You need to uncomment the regarding `sensors`, and set the value to `force`.
 
 ```shell
 # example=force
@@ -47,8 +46,7 @@ sensors=force
 
 ## Configuration
 
-Edit the `charts.d/sensors.conf` configuration file using `edit-config` from the
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is typically at `/etc/netdata`.
+Edit the `charts.d/sensors.conf` configuration file using `edit-config`:
 
 ```bash
 cd /etc/netdata   # Replace this path with your Netdata config directory, if different
@@ -79,5 +77,3 @@ sensors_excluded=()
 ```
 
 ---
-
-
-- 
cgit v1.2.3