Docs: Fixes to new health documentation structure (#7419)
* Fixed link * Added GA links
Joel Hans committed
Dec 4, 2019 at 10:29 UTC
a7a88ba2723242da1de6626df0541d2091bd9b2b
6 files changed
+12
-4
daemon/config/README.md
+3
-3
@@ -169,7 +169,7 @@ that is information about lines that begin with `dim`, which affect a chart's di
169
| `units` | Text for the label of the vertical axis of the chart. This means all dimensions should have the same unit of measurement. |
170
| `context` | Change the default [context](../../web/README.md#contexts) of the chart. Changing this setting will affect what metrics and metrics the chart displays, and which alarms are attached to it. |
171
| `priority` | Define where the chart should appear on the Netdata dashboard. Lower values equal higher priority, so a priority of `1` will place the chart highest, while a priority of `9999999` would place the chart at the bottom of the Netdata dashboard. |
172
-| `name` | The name of the chart that appears in the top-left corner, after the chart's title. You can also use this name when writing [health entities](../../health/README.md#). |
172
+| `name` | The name of the chart that appears in the top-left corner, after the chart's title. You can also use this name when writing [health entities](../../health/REFERENCE.md#health-entity-reference). |
173
| `title` | The text that appears above the chart in the Netdata dashboard. |
174
175
### Dimension settings
@@ -183,8 +183,8 @@ Each dimension setting has the following structure: `dim [DIMENSION ID] [OPTION]
183
| :----------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
184
| `name` | The name of the dimension as it will appear in the legend of the chart. If left empty, or is missing, Netdata will use the `[DIMENSION ID]` instead. |
185
| `algorithm` | Can be `absolute`, `incremental`, `percentage-of-absolute-row`, or `percentage-of-incremental-row`. If this setting is empty, invalid, or missing, Netdata will use `absolute`. See the list beneath this table for descriptions of what each algorithm does. |
186
-| `multiplier` | An integer value by which to multiply the collected value. If empty or missing, Netdata will use `1`. This setting is often used with the value `1024` to convert metabytes to kilobytes, kilobytes to bytes, and so on. |
187
-| `divisor` | An integer value by which to divide the collected value. If empty or missing, Netdata will use `1`. This setting is often used with the value `1024` to convert bytes to kilobytes, kilobytes to megabytes, and so on. |
186
+| `multiplier` | An integer value by which to multiply the collected value. If empty or missing, Netdata will use `1`. This setting is often used with the value `1024` to convert metabytes to kilobytes, kilobytes to bytes, and so on. |
187
+| `divisor` | An integer value by which to divide the collected value. If empty or missing, Netdata will use `1`. This setting is often used with the value `1024` to convert bytes to kilobytes, kilobytes to megabytes, and so on. |
188
189
Here are the options for the `algorithm` setting:
190
health/QUICKSTART.md
+2
@@ -127,3 +127,5 @@ Or, get guided insights into specific health configurations with our [health tut
127
128
Finally, move on to Netdata's [notification system](notifications/README.md) to learn more about how Netdata can let you
129
know when the health of your systems or apps goes awry.
130
+
131
+[](<>)
health/README.md
+2
@@ -43,3 +43,5 @@ content.
43
## Related features
44
45
**[Health notifications](notifications/README.md)**: Get notified about Netdata's alarms via your favorite platform(s).
46
+
47
+[](<>)
health/REFERENCE.md
+2
@@ -722,3 +722,5 @@ It's currently not possible to schedule notifications from within the alarm temp
722
to temporary disable notifications (for instance when running backups triggers a disk alert) you can disable or silence
723
notifications are runtime. The health checks can be controlled at runtime via the [health management
724
api](../web/api/health/).
725
+
726
+[](<>)
health/tutorials/dimension-templates.md
+1
-1
@@ -168,4 +168,4 @@ Or, at the very least, simplify your configuration files.
168
For information about other advanced features in Netdata's health monitoring toolkit, check out our [health
169
documentation](../../health/). And if you have some cool alarms you built using dimension templates,
170
171
-[](<>)
171
+[](<>)
health/tutorials/stop-notifications-alarms.md
+2
@@ -83,3 +83,5 @@ system](../notifications/README.md).
83
You can also use Netdata's [Health Management API](../../web/api/health/README.md#health-management-api) to control
84
health checks and notifications while Netdata runs. With this API, you can disable health checks during a maintenance
85
window or backup process, for example.
86
+
87
+[](<>)