fix some docs issues (#18553)
Ilya Mashchenko committed
Sep 14, 2024 at 23:12 UTC
8d8a6a8cd9231239cd330ae20edd4abebea12648
8 files changed
+39
-50
docs/dashboards-and-charts/alerts-tab.md
+1
-1
@@ -45,7 +45,7 @@ At the bottom of the panel you can click the green button "View alert page" to o
45
46
### Silence an alert
47
48
-From this tab, the "Silencing" column shows if there is any rule present for each alert, and from the "Actions" column you can create a new [silencing rule](/docs/alerts-and-notifications/notifications/centralized-cloud-notifications/centralized-cloud-notifications-reference.md#alert-notifications-silencing-rules) for this alert, or get help and information about this alert from the [Netdata Assistant](/docs/netdata-assistant.md).
48
+From this tab, the "Silencing" column shows if there is any rule present for each alert, and from the "Actions" column you can create a new [silencing rule](/docs/alerts-and-notifications/notifications/centralized-cloud-notifications/centralized-cloud-notifications-reference.md#alert-notification-silencing-rules) for this alert, or get help and information about this alert from the [Netdata Assistant](/docs/netdata-assistant.md).
49
50
## Alert Configurations tab
51
docs/dashboards-and-charts/anomaly-advisor-tab.md
+2
-2
@@ -3,9 +3,9 @@
3
The Anomaly Advisor tab lets you focus on potentially anomalous metrics and charts related to a particular highlighted window of interest. In addition to this tab, each chart in the [Metrics tab](/docs/dashboards-and-charts/metrics-tab-and-single-node-tabs.md) also has an [Anomaly Rate ribbon](/docs/dashboards-and-charts/netdata-charts.md#anomaly-rate-ribbon).
4
5
6
-More details about configuration can be found in the [ML documentation](/src/ml/README.md#configuration).
6
+More details about configuration can be found in the [ML documentation](/src/ml/README.md).
7
8
-This tab uses our [Anomaly Rate ML feature](/src/ml/README.md#anomaly-rate---averageanomaly-bit) to score metrics in terms of anomalous behavior.
8
+This tab uses our [Anomaly Rate ML feature](/src/ml/README.md#anomaly-bit) to score metrics in terms of anomalous behavior.
9
10
- The "Anomaly Rate" chart shows the percentage of anomalous metrics over time per node.
11
docs/developer-and-contributor-corner/collect-apache-nginx-web-logs.md
+1
-1
@@ -82,7 +82,7 @@ jobs:
82
```
83
84
Restart Netdata with `sudo systemctl restart netdata`, or the [appropriate
85
-method](/packaging/installer/README.md#maintaining-a-netdata-agent-installation) for your system. Netdata should pick up your web server's access log and
85
+method](/docs/netdata-agent/start-stop-restart.md)) for your system. Netdata should pick up your web server's access log and
86
begin showing real-time charts!
87
88
### Custom log formats and fields
docs/netdata-agent/backup-and-restore-an-agent.md
+2
-2
@@ -46,7 +46,7 @@ If you want to minimize the gap in metrics caused by stopping the Netdata Agent,
46
47
### Restoring Netdata
48
49
-1. Ensure that the Netdata agent is installed and is [stopped](/packaging/installer/README.md#maintaining-a-netdata-agent-installation)
49
+1. Ensure that the Netdata agent is installed and is [stopped](/docs/netdata-agent/start-stop-restart.md))
50
51
If you plan to deploy the Agent and restore a backup on top of it, then you might find it helpful to use the [`--dont-start-it`](/packaging/installer/methods/kickstart.md#other-options) option upon installation.
52
@@ -67,4 +67,4 @@ If you want to minimize the gap in metrics caused by stopping the Netdata Agent,
67
sudo tar -xvpzf /path/to/netdata_backup.tar.gz -C /
68
```
69
70
-3. [Start the Netdata agent](/packaging/installer/README.md#maintaining-a-netdata-agent-installation)
70
+3. [Start the Netdata agent](/docs/netdata-agent/start-stop-restart.md))
docs/netdata-agent/configuration/common-configuration-changes.md
+1
-5
@@ -19,11 +19,7 @@ changes reflected in those visualizations due to the way Netdata Cloud proxies m
19
20
### Increase the long-term metrics retention period
21
22
-Read our doc
23
-on [increasing long-term metrics storage](/docs/netdata-agent/configuration/optimizing-metrics-database/change-metrics-storage.md)
24
-for details, including a
25
-[calculator](/docs/netdata-agent/configuration/optimizing-metrics-database/change-metrics-storage.md#calculate-the-system-resources-ram-disk-space-needed-to-store-metrics)
26
-to help you determine the exact settings for your desired retention period.
22
+Read our doc on [increasing long-term metrics storage](/docs/netdata-agent/configuration/optimizing-metrics-database/change-metrics-storage.md) for details.
23
24
### Reduce the data collection frequency
25
packaging/installer/methods/ansible.md
+1
-1
@@ -10,7 +10,7 @@ learn_rel_path: "Installation/Install on specific environments"
10
11
# Deploy Netdata with Ansible
12
13
-Netdata's [one-line kickstart](/packaging/installer/README.md#install-on-linux-with-one-line-installer) is zero-configuration, highly adaptable, and compatible with tons
13
+Netdata's [one-line kickstart](/packaging/installer/README.md) is zero-configuration, highly adaptable, and compatible with tons
14
of different operating systems and Linux distributions. You can use it on bare metal, VMs, containers, and everything
15
in-between.
16
packaging/maintainers/README.md
+30
-37
@@ -8,67 +8,60 @@ This page tracks the package maintainers for Netdata, for various operating syst
8
9
## Official Linux Distributions
10
11
-| Linux Distribution | Netdata Version | Maintainer | Related URL |
12
-| :-: | :-: | :-: | :-- |
13
-| Arch Linux | Release | @svenstaro | [netdata @ Arch Linux](https://www.archlinux.org/packages/community/x86_64/netdata/) |
14
-| Arch Linux AUR | Git | @sanskritfritz | [netdata @ AUR](https://aur.archlinux.org/packages/netdata-git/) |
15
-| Gentoo Linux | Release + Git | @candrews | [netdata @ gentoo](https://github.com/gentoo/gentoo/tree/master/net-analyzer/netdata) |
16
-| Debian | Release | @lhw @FedericoCeratto | [netdata @ debian](http://salsa.debian.org/debian/netdata) |
17
-| Slackware | Release | @willysr | [netdata @ slackbuilds](https://slackbuilds.org/repository/14.2/system/netdata/) |
18
-| Ubuntu | | | |
19
-| Red Hat / Fedora / CentOS | | | |
20
-| SUSE SLE / openSUSE Tumbleweed & Leap | | | [netdata @ SUSE OpenBuildService](https://software.opensuse.org/package/netdata) |
11
+| Linux Distribution | Netdata Version | Maintainer | Related URL |
12
+|:-------------------------------------:|:---------------:|:---------------------:|:--------------------------------------------------------------------------------------|
13
+| Arch Linux | Release | @svenstaro | [netdata @ Arch Linux](https://www.archlinux.org/packages/community/x86_64/netdata/) |
14
+| Arch Linux AUR | Git | @sanskritfritz | [netdata @ AUR](https://aur.archlinux.org/packages/netdata-git/) |
15
+| Gentoo Linux | Release + Git | @candrews | [netdata @ gentoo](https://github.com/gentoo/gentoo/tree/master/net-analyzer/netdata) |
16
+| Debian | Release | @lhw @FedericoCeratto | [netdata @ debian](http://salsa.debian.org/debian/netdata) |
17
+| Slackware | Release | @willysr | [netdata @ slackbuilds](https://slackbuilds.org/repository/14.2/system/netdata/) |
18
+| Ubuntu | | | |
19
+| Red Hat / Fedora / CentOS | | | |
20
+| SUSE SLE / openSUSE Tumbleweed & Leap | | | [netdata @ SUSE OpenBuildService](https://software.opensuse.org/package/netdata) |
21
22
---
23
24
## FreeBSD
25
26
-| System | Initial PR | Core Developer | Package Maintainer
27
-|:-:|:-:|:-:|:-:|
28
-| FreeBSD | #1321 | @vlvkobal|@mmokhi
26
+| System | Initial PR | Core Developer | Package Maintainer |
27
+|:-------:|:----------:|:--------------:|:------------------:|
28
+| FreeBSD | #1321 | | @mmokhi |
29
30
---
31
32
## macOS
33
34
-| System | URL | Core Developer | Package Maintainer
35
-|:-:|:-:|:-:|:-:|
36
-| macOS Homebrew Formula|[link](https://github.com/Homebrew/homebrew-core/blob/master/Formula/n/netdata.rb)|@vlvkobal|@rickard-von-essen
34
+| System | URL | Core Developer | Package Maintainer |
35
+|:----------------------:|:----------------------------------------------------------------------------------:|:--------------:|:------------------:|
36
+| macOS Homebrew Formula | [link](https://github.com/Homebrew/homebrew-core/blob/master/Formula/n/netdata.rb) | | |
37
38
---
39
40
## Unofficial Linux Packages
41
42
-| Linux Distribution | Netdata Version | Maintainer | Related URL |
43
-| :-: | :-: | :-: | :-- |
44
-| Ubuntu | Release | @gslin | [netdata @ gslin ppa](https://launchpad.net/~gslin/+archive/ubuntu/netdata) https://github.com/netdata/netdata/issues/69#issuecomment-217458543 |
45
----
46
-
47
-## Embedded Linux
48
-
49
-| Embedded Linux | Netdata Version | Maintainer | Related URL |
50
-| :-: | :-: | :-: | :-- |
51
-| OpenWRT | Release | @nitroshift | [openwrt package](https://github.com/openwrt/packages/tree/master/admin/netdata) |
52
-| ReadyNAS | Release | @NAStools | https://github.com/nastools/netdata |
53
-| QNAP | Release | QNAP_Stephane | https://forum.qnap.com/viewtopic.php?t=121518 |
54
-| DietPi | Release | @Fourdee | https://github.com/Fourdee/DietPi |
42
+| Linux Distribution | Netdata Version | Maintainer | Related URL |
43
+|:------------------:|:---------------:|:----------:|:------------------------------------------------------------------------------------------------------------------------------------------------|
44
+| Ubuntu | Release | @gslin | [netdata @ gslin ppa](https://launchpad.net/~gslin/+archive/ubuntu/netdata) https://github.com/netdata/netdata/issues/69#issuecomment-217458543 |
45
46
---
47
58
-## Linux Containers
48
+## Embedded Linux
49
60
-| Containers | Netdata Version | Maintainer | Related URL |
61
-| :-: | :-: | :-: | :-- |
62
-| Docker | Git | @titpetric | https://github.com/titpetric/netdata |
50
+| Embedded Linux | Netdata Version | Maintainer | Related URL |
51
+|:--------------:|:---------------:|:-------------:|:---------------------------------------------------------------------------------|
52
+| OpenWRT | Release | @nitroshift | [openwrt package](https://github.com/openwrt/packages/tree/master/admin/netdata) |
53
+| ReadyNAS | Release | @NAStools | https://github.com/nastools/netdata |
54
+| QNAP | Release | QNAP_Stephane | https://forum.qnap.com/viewtopic.php?t=121518 |
55
+| DietPi | Release | @Fourdee | https://github.com/Fourdee/DietPi |
56
57
---
58
59
## Automation Systems
60
68
-| Automation Systems | Netdata Version | Maintainer | Related URL |
69
-| :-: | :-: | :-: | :-- |
70
-| Ansible | git | @jffz | https://galaxy.ansible.com/jffz/netdata/ |
71
-| Chef | ? | @sergiopena | https://github.com/sergiopena/netdata-cookbook |
61
+| Automation Systems | Netdata Version | Maintainer | Related URL |
62
+|:------------------:|:---------------:|:-----------:|:-----------------------------------------------|
63
+| Ansible | git | @jffz | https://galaxy.ansible.com/jffz/netdata/ |
64
+| Chef | ? | @sergiopena | https://github.com/sergiopena/netdata-cookbook |
65
66
---
67
src/aclk/mqtt_websockets/README.md
+1
-1
@@ -4,4 +4,4 @@ Library to connect MQTT client over Websockets Secure (WSS).
4
5
## License
6
7
-The Project is released under GPL v3 license. See [License](LICENSE)
7
+The Project is released under GPL v3 license. See [License](/LICENSE)