diff options
author | Ilya Mashchenko <ilya@netdata.cloud> | 2022-01-28 00:45:37 +0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-01-28 00:45:37 +0300 |
commit | 6b73721381141982c0d74db0ff0ab3bc5b7c56a3 (patch) | |
tree | 65b9a9bec7da4b6b3d7ecb714ebddf0eea9b3816 | |
parent | 98f33197afd791aba63939008748357ac44e2508 (diff) |
fix(docs): unresolved file references (#12053)
-rw-r--r-- | README.md | 2 | ||||
-rw-r--r-- | aclk/README.md | 3 | ||||
-rw-r--r-- | claim/README.md | 2 | ||||
-rw-r--r-- | collectors/README.md | 9 | ||||
-rw-r--r-- | collectors/REFERENCE.md | 7 | ||||
-rw-r--r-- | collectors/ebpf.plugin/README.md | 2 | ||||
-rw-r--r-- | docs/Add-more-charts-to-netdata.md | 3 | ||||
-rw-r--r-- | docs/guides/monitor/pi-hole-raspberry-pi.md | 2 | ||||
-rw-r--r-- | docs/guides/step-by-step/step-00.md | 2 | ||||
-rw-r--r-- | health/notifications/pushbullet/README.md | 2 | ||||
-rw-r--r-- | packaging/installer/methods/kickstart.md | 2 | ||||
-rw-r--r-- | packaging/installer/methods/manual.md | 3 | ||||
-rw-r--r-- | packaging/installer/methods/synology.md | 2 |
13 files changed, 15 insertions, 26 deletions
@@ -156,7 +156,7 @@ To view the Netdata dashboard, navigate to `http://localhost:19999`, or `http:// See our documentation for [additional operating systems](/packaging/installer/README.md#have-a-different-operating-system-or-want-to-try-another-method), including [Kubernetes](/packaging/installer/methods/kubernetes.md), [`.deb`/`.rpm` -packages](/packaging/installer/methods/packages.md), and more. +packages](/packaging/installer/methods/kickstart.md#native-packages), and more. ### Post-installation diff --git a/aclk/README.md b/aclk/README.md index 414cca41ba..76553d4792 100644 --- a/aclk/README.md +++ b/aclk/README.md @@ -91,8 +91,7 @@ You have two options if you prefer to disable the ACLK and not use Netdata Cloud ### Disable at installation You can pass the `--disable-cloud` parameter to the Agent installation when using a kickstart script -([kickstart.sh](/packaging/installer/methods/kickstart.md) or -[kickstart-static64.sh](/packaging/installer/methods/kickstart-64.md)), or a [manual installation from +([kickstart.sh](/packaging/installer/methods/kickstart.md), or a [manual installation from Git](/packaging/installer/methods/manual.md). When you pass this parameter, the installer does not download or compile any extra libraries. Once running, the Agent diff --git a/claim/README.md b/claim/README.md index 99c26076cf..3666d1eca4 100644 --- a/claim/README.md +++ b/claim/README.md @@ -337,7 +337,7 @@ If you're running an older Linux distribution or one that has reached EOL, such versions of OpenSSL cannot perform [hostname validation](https://wiki.openssl.org/index.php/Hostname_validation), which helps securely encrypt SSL connections. -We recommend you reinstall Netdata with a [static build](/packaging/installer/methods/kickstart-64.md), which uses an +We recommend you reinstall Netdata with a [static build](/packaging/installer/methods/kickstart.md#static-builds), which uses an up-to-date version of OpenSSL with hostname validation enabled. If you choose to continue using the outdated version of OpenSSL, your node will still connect to Netdata Cloud, albeit diff --git a/collectors/README.md b/collectors/README.md index a37a7e890a..e9cce42b39 100644 --- a/collectors/README.md +++ b/collectors/README.md @@ -7,8 +7,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/READM Netdata can collect metrics from hundreds of different sources, be they internal data created by the system itself, or external data created by services or applications. To see _all_ of the sources Netdata collects from, view our [list of -supported collectors](/collectors/COLLECTORS.md), and then view our [quickstart guide](/collectors/QUICKSTART.md) to get -up-and-running. +supported collectors](/collectors/COLLECTORS.md). There are two essential points to understand about how collecting metrics works in Netdata: @@ -17,13 +16,11 @@ There are two essential points to understand about how collecting metrics works - Upon startup, Netdata will **auto-detect** any application or service that has a [collector](/collectors/COLLECTORS.md), as long as both the collector and the app/service are configured correctly. -Most users will want to enable a new Netdata collector for their app/service. For those details, see our [quickstart -guide](/collectors/QUICKSTART.md). +Most users will want to enable a new Netdata collector for their app/service. For those details, see +our [collectors' configuration reference](/collectors/REFERENCE.md). ## Take your next steps with collectors -[Collectors quickstart](/collectors/QUICKSTART.md) - [Supported collectors list](/collectors/COLLECTORS.md) [Collectors configuration reference](/collectors/REFERENCE.md) diff --git a/collectors/REFERENCE.md b/collectors/REFERENCE.md index e5c52115e8..fc9ed366d3 100644 --- a/collectors/REFERENCE.md +++ b/collectors/REFERENCE.md @@ -10,9 +10,6 @@ Welcome to the collector configuration reference guide. This guide contains detailed information about enabling/disabling plugins or modules, in addition a quick reference to the internal plugins API. -To learn the basics of collecting metrics from other applications and services, see the [collector -quickstart](QUICKSTART.md). - ## Netdata's collector architecture Netdata has an intricate system for organizing and managing its collectors. **Collectors** are the processes/programs @@ -23,8 +20,7 @@ MySQL database, among many others. For most users, enabling individual collectors for the application/service you're interested in is far more important than knowing which plugin it uses. See our [collectors list](/collectors/COLLECTORS.md) to see whether your favorite app/service has -a collector, and then read the [collectors quickstart](/collectors/QUICKSTART.md) and the documentation for that specific collector -to figure out how to enable it. +a collector, and then read the documentation for that specific collector to figure out how to enable it. There are three types of plugins: @@ -46,7 +42,6 @@ However, there are cases that auto-detection fails. Usually, the reason is that allow Netdata to connect. In most of the cases, allowing the user `netdata` from `localhost` to connect and collect metrics, will automatically enable data collection for the application in question (it will require a Netdata restart). -View our [collectors quickstart](/collectors/QUICKSTART.md) for explicit details on enabling and configuring collector modules. ## Troubleshoot a collector diff --git a/collectors/ebpf.plugin/README.md b/collectors/ebpf.plugin/README.md index 8fc6809e22..babcd5206b 100644 --- a/collectors/ebpf.plugin/README.md +++ b/collectors/ebpf.plugin/README.md @@ -45,7 +45,7 @@ which allow hooking into arbitrary user-space functions in a similar manner to k ## Manually enable the collector on Linux **The eBPF collector is installed and enabled by default on most new installations of the Agent**. The eBPF collector -does not currently work with [static build installations](/packaging/installer/methods/kickstart-64.md) for kernels older +does not currently work with [static build installations](/packaging/installer/methods/kickstart.md#static-builds) for kernels older than `4.11`, but improved support is in active development. eBPF monitoring only works on Linux systems and with specific Linux kernels, including all kernels newer than `4.11.0`, diff --git a/docs/Add-more-charts-to-netdata.md b/docs/Add-more-charts-to-netdata.md index a16f2e9dbc..44aa1abad3 100644 --- a/docs/Add-more-charts-to-netdata.md +++ b/docs/Add-more-charts-to-netdata.md @@ -5,8 +5,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Add-more-ch # Add more charts to Netdata -This file has been deprecated. Please see our [collectors docs](/collectors/README.md) or the collectors [quickstart -guide](/collectors/QUICKSTART.md) for more information. +This file has been deprecated. Please see our [collectors docs](/collectors/README.md) for more information. ## Available data collection modules diff --git a/docs/guides/monitor/pi-hole-raspberry-pi.md b/docs/guides/monitor/pi-hole-raspberry-pi.md index 4147ca9769..0d093c486c 100644 --- a/docs/guides/monitor/pi-hole-raspberry-pi.md +++ b/docs/guides/monitor/pi-hole-raspberry-pi.md @@ -100,7 +100,7 @@ part of your system might affect another. action](https://user-images.githubusercontent.com/1153921/80827388-b9fee100-8b98-11ea-8f60-0d7824667cd3.gif) If you're completely new to Netdata, look at our [step-by-step guide](/docs/guides/step-by-step/step-00.md) for a -walkthrough of all its features. For a more expedited tour, see the [get started guide](/docs/get-started.md). +walkthrough of all its features. For a more expedited tour, see the [get started guide](/docs/get-started.mdx). ### Enable temperature sensor monitoring diff --git a/docs/guides/step-by-step/step-00.md b/docs/guides/step-by-step/step-00.md index 0a49defe3b..490cbbc9f5 100644 --- a/docs/guides/step-by-step/step-00.md +++ b/docs/guides/step-by-step/step-00.md @@ -17,7 +17,7 @@ completely new to Netdata, or have never tried health monitoring/performance tro guide is perfect for you. If you have monitoring experience, or would rather get straight into configuring Netdata to your needs, you can jump -straight into code and configurations with our [getting started guide](/docs/get-started.md). +straight into code and configurations with our [getting started guide](/docs/get-started.mdx). > This guide contains instructions for Netdata installed on a Linux system. Many of the instructions will work on > other supported operating systems, like FreeBSD and macOS, but we can't make any guarantees. diff --git a/health/notifications/pushbullet/README.md b/health/notifications/pushbullet/README.md index a1c88c703e..7c2f6774e0 100644 --- a/health/notifications/pushbullet/README.md +++ b/health/notifications/pushbullet/README.md @@ -14,7 +14,7 @@ And like this on your Android device: You will need: -1. Sign up and log in to [pushbullet.com](pushbullet.com) +1. Sign up and log in to [pushbullet.com](https://www.pushbullet.com/) 2. Create a new access token in your [account settings](https://www.pushbullet.com/#settings/account). 3. Fill in the `PUSHBULLET_ACCESS_TOKEN` with the newly generated access token. 4. Add the recipient emails or channel tags (each channel tag must be prefixed with #, e.g. #channeltag) to `DEFAULT_RECIPIENT_PUSHBULLET`. diff --git a/packaging/installer/methods/kickstart.md b/packaging/installer/methods/kickstart.md index bb983a5957..1531f48aca 100644 --- a/packaging/installer/methods/kickstart.md +++ b/packaging/installer/methods/kickstart.md @@ -11,7 +11,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/instal This page covers detailed instructions on using and configuring the automatic one-line installation script named `kickstart.sh`. -The kickstart script works on all Linux distributions and macOS environments. By default, automatic nightly updates are enabled. If you are installing on macOS, make sure to check the [install documentation for macOS](packaging/installer/methods/macos) before continuing. +The kickstart script works on all Linux distributions and macOS environments. By default, automatic nightly updates are enabled. If you are installing on macOS, make sure to check the [install documentation for macOS](packaging/installer/methods/macos.md) before continuing. > If you are unsure whether you want nightly or stable releases, read the [installation guide](/packaging/installer/README.md#nightly-vs-stable-releases). > If you want to turn off [automatic updates](/packaging/installer/README.md#automatic-updates), use the `--no-updates` option. You can find more installation options below. diff --git a/packaging/installer/methods/manual.md b/packaging/installer/methods/manual.md index 73cedd24d1..6d88fbd8e5 100644 --- a/packaging/installer/methods/manual.md +++ b/packaging/installer/methods/manual.md @@ -220,8 +220,7 @@ cd netdata ### Connect node to Netdata Cloud during installation -Unlike the [`kickstart.sh`](/packaging/installer/methods/kickstart.md) or -[`kickstart-static64.sh`](/packaging/installer/methods/kickstart-64.md) methods, the `netdata-installer.sh` script does +Unlike the [`kickstart.sh`](/packaging/installer/methods/kickstart.md), the `netdata-installer.sh` script does not allow you to automatically [connect](/claim/README.md) your node to Netdata Cloud immediately after installation. See the [connect to cloud](/claim/README.md) doc for details on connecting a node with a manual installation of Netdata. diff --git a/packaging/installer/methods/synology.md b/packaging/installer/methods/synology.md index 07b1596fd4..68349e112c 100644 --- a/packaging/installer/methods/synology.md +++ b/packaging/installer/methods/synology.md @@ -13,7 +13,7 @@ issue](https://github.com/SynoCommunity/spksrc/issues/2758), still open as of 20 Chroot package is not suitable for DSM versions greater than version 5 and may corrupt system libraries and render the NAS unable to boot. -The good news is that the [64-bit static installer](kickstart-64.md) works fine if your NAS is one that uses the amd64 architecture. It +The good news is that our [one-line installation script](kickstart.md) works fine if your NAS is one that uses the amd64 architecture. It will install the content into `/opt/netdata`, making future removal safe and simple. ## Run as netdata user |