summaryrefslogtreecommitdiffstats
path: root/health
diff options
context:
space:
mode:
authorJoel Hans <joel@netdata.cloud>2020-04-14 10:26:13 -0700
committerGitHub <noreply@github.com>2020-04-14 10:26:13 -0700
commite99692f145f710930723081d2e5bbf8868be2080 (patch)
tree468157463f0f133d927019e6826a9559dd989b9b /health
parent59916b01b83026d6e6caf59f4efb67b7d428b70d (diff)
Docs: Standardize links between documentation (#8638)
* Trying out some absolute-ish links * Try one out on installer * Testing logic * Trying out some more links * Fixing links * Fix links in python collectors * Changed a bunch more links * Fix build errors * Another push of links * Fix build error and add more links * Complete first pass * Fix final broken links * Fix links to files * Fix for Netlify * Two more fixes
Diffstat (limited to 'health')
-rw-r--r--health/QUICKSTART.md8
-rw-r--r--health/README.md11
-rw-r--r--health/notifications/README.md14
-rw-r--r--health/notifications/custom/README.md2
4 files changed, 17 insertions, 18 deletions
diff --git a/health/QUICKSTART.md b/health/QUICKSTART.md
index edaf34b776..05e78df91c 100644
--- a/health/QUICKSTART.md
+++ b/health/QUICKSTART.md
@@ -138,11 +138,11 @@ killall -USR2 netdata
## What's next?
-To learn about all of Netdata's health configuration options, view the [reference guide](REFERENCE.md).
+To learn about all of Netdata's health configuration options, view the [reference guide](/health/REFERENCE.md).
-Or, get guided insights into specific health configurations with our [health tutorials](README.md#tutorials).
+Or, get guided insights into specific health configurations with our [health tutorials](/health/README.md#tutorials).
-Finally, move on to Netdata's [notification system](notifications/README.md) to learn more about how Netdata can let you
-know when the health of your systems or apps goes awry.
+Finally, move on to Netdata's [notification system](/health/notifications/README.md) to learn more about how Netdata can
+let you know when the health of your systems or apps goes awry.
[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fhealth%2Fquickstart%2F&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)
diff --git a/health/README.md b/health/README.md
index d10face5b6..b3d26e31e0 100644
--- a/health/README.md
+++ b/health/README.md
@@ -21,9 +21,9 @@ and the needs of your infrastructure, are your only limits.
<DocsSteps>
-[<FiPlay /> Quickstart](QUICKSTART.md)
+[<FiPlay /> Quickstart](/health/QUICKSTART.md)
-[<FiCode /> Configuration reference](REFERENCE.md)
+[<FiCode /> Configuration reference](/health/REFERENCE.md)
[<FiBook /> Tutorials](#tutorials)
@@ -40,15 +40,16 @@ content.
### Health entities
-[Stopping notifications for individual alarms](tutorials/stop-notifications-alarms.md)
+[Stopping notifications for individual alarms](/health/tutorials/stop-notifications-alarms.md)
-[Use dimension templates to create dynamic alarms](tutorials/dimension-templates.md)
+[Use dimension templates to create dynamic alarms](/health/tutorials/dimension-templates.md)
</div>
</DocsTutorials>
## Related features
-**[Health notifications](notifications/README.md)**: Get notified about Netdata's alarms via your favorite platform(s).
+**[Health notifications](/health/notifications/README.md)**: Get notified about Netdata's alarms via your favorite
+platform(s).
[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fhealth%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)
diff --git a/health/notifications/README.md b/health/notifications/README.md
index 5d8dc09aea..cbe296b838 100644
--- a/health/notifications/README.md
+++ b/health/notifications/README.md
@@ -8,7 +8,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notificat
# Netdata alarm notifications
The `exec` line in health configuration defines an external script that will be called once
-the alarm is triggered. The default script is **[alarm-notify.sh](alarm-notify.sh.in)**.
+the alarm is triggered. The default script is `alarm-notify.sh`.
You can change the default script globally by editing `/etc/netdata/netdata.conf`.
@@ -20,11 +20,10 @@ You can change the default script globally by editing `/etc/netdata/netdata.conf
It uses **roles**. For example `sysadmin`, `webmaster`, `dba`, etc.
-Each alarm is assigned to one or more roles, using the `to` line of the alarm configuration.
-Then `alarm-notify.sh` uses its own configuration file `/etc/netdata/health_alarm_notify.conf`
-the default is [here](health_alarm_notify.conf)
-(to edit it on your system run `/etc/netdata/edit-config health_alarm_notify.conf`)
-to find the destination address of the notification for each method.
+Each alarm is assigned to one or more roles, using the `to` line of the alarm configuration. Then `alarm-notify.sh` uses
+its own configuration file `/etc/netdata/health_alarm_notify.conf`. To edit it on your system, run
+`/etc/netdata/edit-config health_alarm_notify.conf` and find the destination address of the notification for each
+method.
Each role may have one or more destinations.
@@ -38,8 +37,7 @@ So, for example the `sysadmin` role may send:
## Configuration
-Edit [`/etc/netdata/health_alarm_notify.conf`](health_alarm_notify.conf)
-by running `/etc/netdata/edit-config health_alarm_notify.conf`:
+Edit `/etc/netdata/health_alarm_notify.conf` by running `/etc/netdata/edit-config health_alarm_notify.conf`:
- settings per notification method:
diff --git a/health/notifications/custom/README.md b/health/notifications/custom/README.md
index de64bcbfa7..4c0049b9a5 100644
--- a/health/notifications/custom/README.md
+++ b/health/notifications/custom/README.md
@@ -9,7 +9,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notificat
Netdata allows you to send custom notifications to any endpoint you choose.
-To configure custom notifications, you will need to customize `health_alarm_notify.conf`. You can look at the other senders in `/usr/libexec/netdata/plugins.d/alarm-notify.sh` for examples of how to modify the `custom_sender()` function in `health_alarm_notify.conf`. Ensure you follow the instructions of changing any configuration file to [persist your configuration](../../../docs/configuration-guide.md#persist-my-configuration).
+To configure custom notifications, you will need to customize `health_alarm_notify.conf`. You can look at the other senders in `/usr/libexec/netdata/plugins.d/alarm-notify.sh` for examples of how to modify the `custom_sender()` function in `health_alarm_notify.conf`. Ensure you follow the instructions of changing any configuration file to [persist your configuration](/docs/configuration-guide.md#persist-my-configuration).
As with other notifications, you will also need to define the recipient list in `DEFAULT_RECIPIENT_CUSTOM` and/or the `role_recipients_custom` array.