Skip to content

Commit

Permalink
fix broken links and links pointing to Learn (netdata#17675)
Browse files Browse the repository at this point in the history
  • Loading branch information
Ancairon authored May 16, 2024
1 parent 6860a57 commit 9e23625
Show file tree
Hide file tree
Showing 77 changed files with 114 additions and 484 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<p align="center">
<a href="https://github.com/netdata/netdata/"><img src="https://img.shields.io/github/stars/netdata/netdata?style=social" alt="GitHub Stars"></a>
<br />
<a href="https://app.netdata.cloud/spaces/netdata-demo?utm_campaign=github_readme_demo_badge"><img src="https://img.shields.io/badge/Live Demo-green" alt="Live Demo"></a>
<a href="https://app.netdata.cloud/spaces/netdata-demo?utm_campaign=github_readme_demo_badge"><img src="https://img.shields.io/badge/Live%20Demo-green" alt="Live Demo"></a>
<a href="https://github.com/netdata/netdata/releases/latest"><img src="https://img.shields.io/github/release/netdata/netdata.svg" alt="Latest release"></a>
<a href="https://github.com/netdata/netdata-nightlies/releases/latest"><img src="https://img.shields.io/github/release/netdata/netdata-nightlies.svg" alt="Latest nightly build"></a>
<br />
Expand Down Expand Up @@ -256,7 +256,7 @@ Check the [systemd-journal plugin of Netdata](https://github.com/netdata/netdata
Netdata can be installed on all Linux, macOS, and FreeBSD systems. We provide binary packages for the most popular operating systems and package managers.

- Install on [Ubuntu, Debian CentOS, Fedora, Suse, Red Hat, Arch, Alpine, Gentoo, even BusyBox](https://learn.netdata.cloud/docs/installing/one-line-installer-for-all-linux-systems).
- Install with [Docker](https://learn.netdata.cloud/docs/installing/docker).<br/>
- Install with [Docker](https://github.com/netdata/netdata/blob/master/packaging/docker/README.md).<br/>
Netdata is a [Verified Publisher on DockerHub](https://hub.docker.com/r/netdata/netdata) and our users enjoy free unlimited DockerHub pulls :heart_eyes:.
- Install on [MacOS](https://learn.netdata.cloud/docs/installing/macos) :metal:.
- Install on [FreeBSD](https://learn.netdata.cloud/docs/installing/freebsd) and [pfSense](https://learn.netdata.cloud/docs/installing/pfsense).
Expand Down Expand Up @@ -429,7 +429,7 @@ Of course it is! We do our best to ensure it is!
We understand that Netdata is a software piece that is installed on millions of production systems across the world. So, it is important for us, Netdata to be as secure as possible:

- We follow the [Open Source Security Foundation](https://bestpractices.coreinfrastructure.org/en/projects/2231) best practices.
- We have given great attention to detail when it comes to security design. Check out our [security design](https://learn.netdata.cloud/docs/architecture/security-and-privacy-design).
- We have given great attention to detail when it comes to security design. Check out our [security design](https://github.com/netdata/netdata/blob/master/docs/security-and-privacy-design/README.md).
- Netdata is a popular open-source project and is frequently tested by many security analysts.
- Check also our [security policies and advisories published so far](https://github.com/netdata/netdata/security).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@ You can read more about the different options in the [Alerts reference documenta

- **Alert Template Name**: Provide a unique name for the alert.
- **Alert Template Description**: Offer a brief explanation of what the alert monitors.
- **Alert Summary**: Create a custom title for alert notifications, which can be integrated with centralized notification systems available [here](https://learn.netdata.cloud/docs/alerting/notifications/centralized-cloud-notifications).
- **Alert Summary**: Create a custom title for alert notifications, which can be integrated with centralized notification systems available [here](https://learn.netdata.cloud/docs/alerts-&-notifications/notifications/centralized-cloud-notifications).
2 changes: 1 addition & 1 deletion docs/deployment-guides/deployment-strategies.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ On the child node, edit `netdata.conf` by using the edit-config script: `/etc/ne

```yaml
[db]
# https://learn.netdata.cloud/docs/agent/database
# https://github.com/netdata/netdata/blob/master/src/database/README.md
# none = no retention, ram = some retention in ram
mode = ram
# The retention in seconds.
Expand Down
3 changes: 1 addition & 2 deletions packaging/installer/REINSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,5 +62,4 @@ If you still experience problems with your Netdata Agent installation after foll
best route is to [uninstall](https://github.com/netdata/netdata/blob/master/packaging/installer/UNINSTALL.md) and then try a fresh installation using the [one-line
installer](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/kickstart.md).

You can also post to our [community forums](https://community.netdata.cloud/c/support/13) or create a new [bug
report](https://github.com/netdata/netdata/issues/new?assignees=&labels=bug%2Cneeds+triage&template=BUG_REPORT.yml).
You can also post to our [community forums](https://community.netdata.cloud) or create a new [bug report](https://github.com/netdata/netdata/issues/new?assignees=&labels=bug%2Cneeds+triage&template=BUG_REPORT.yml).
2 changes: 1 addition & 1 deletion packaging/installer/UPDATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ brew upgrade netdata
```

Homebrew downloads the latest Netdata via the
[formulae](https://github.com/Homebrew/homebrew-core/blob/master/Formula/netdata.rb), ensures all dependencies are met,
[formulae](https://github.com/Homebrew/homebrew-core/blob/master/Formula/n/netdata.rb), ensures all dependencies are met,
and updates Netdata via reinstallation.

If you instead installed Netdata using our one-line installation script, you can use our [regular update
Expand Down
2 changes: 1 addition & 1 deletion packaging/installer/methods/freebsd.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Please respond in the affirmative for any relevant prompts during the installati

## Install Netdata

The simplest method is to use the single line [kickstart script](https://learn.netdata.cloud/docs/agent/packaging/installer/methods/kickstart)
The simplest method is to use the single line [kickstart script](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/kickstart.md)

If you have a Netdata cloud account then clicking on the **Connect Nodes** button will generate the kickstart command you should use. Use the command from the "Linux" tab, it should look something like this:

Expand Down
6 changes: 3 additions & 3 deletions packaging/installer/methods/manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ and other operating systems and is regularly tested. You can find this tool [her
- Please note that for RHEL/CentOS you need
[EPEL](http://www.tecmint.com/how-to-enable-epel-repository-for-rhel-centos-6-5/).
In addition, RHEL/CentOS version 6 also need
[OKay](https://okay.com.mx/blog-news/rpm-repositories-for-centos-6-and-7.html) for package libuv version 1.
[OKay](https://okay.com.mx) for package libuv version 1.
- CentOS 8 / RHEL 8 requires a bit of extra work. See the dedicated section below.

- **SUSE** Linux and its derivatives (including **openSUSE**)
Expand Down Expand Up @@ -140,7 +140,7 @@ required if manually installing packages.
CentOS 6.x:

- Enable the EPEL repo
- Enable the additional repo from [okay.network](https://okay.network/blog-news/rpm-repositories-for-centos-6-and-7.html)
- Enable the additional repo from [okay.network](https://okay.network)

And install the minimum required dependencies.

Expand All @@ -154,7 +154,7 @@ CentOS 8.x:

- Enable the PowerTools repo
- Enable the EPEL repo
- Enable the Extra repo from [OKAY](https://okay.network/blog-news/rpm-repositories-for-centos-6-and-7.html)
- Enable the Extra repo from [OKAY](https://okay.network)

And install the minimum required dependencies:

Expand Down
19 changes: 8 additions & 11 deletions packaging/installer/methods/packages.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ learn_rel_path: "Installation/Installation methods"
sidebar_position: 20
-->

# Install Netdata using native DEB/RPM packages.
# Install Netdata using native DEB/RPM packages

For most common Linux distributions that use either DEB or RPM packages, Netdata provides pre-built native packages
for current releases in-line with
Expand All @@ -20,8 +20,6 @@ When using the kickstart script, you can force usage of native DEB or RPM packag
`--native-only` when invoking the script. This will cause it to only attempt to use native packages for the install,
and fail if it cannot do so.



> ### Note
>
> In July 2022, we switched hosting of our native packages from Package Cloud to self-hosted repositories.
Expand All @@ -31,10 +29,9 @@ and fail if it cannot do so.
> When selecting a repository configuration package, note that the version 2 packages provide configuration for
> our self-hosted repositories, and then version 1 packages provide configuration for Package Cloud.
## Manual setup of RPM packages

## Manual setup of RPM packages.

Netdata’s official RPM repositories are hosted at https://repo.netdata.cloud/repos. We provide four groups of
Netdata’s official RPM repositories are hosted at <https://repo.netdata.cloud/repos>. We provide four groups of
repositories at that top level:

- `stable`: Contains packages for stable releases of the Netdata Agent.
Expand All @@ -55,14 +52,14 @@ Under each of those directories is a directory for each supported release of tha
directory for each supported CPU architecture which contains the actual repository.

For example, for stable release packages for RHEL 9 on 64-bit x86, the full URL for the repository would be
https://repo.netdata.cloud/repos/stable/el/9/x86_64/
<https://repo.netdata.cloud/repos/stable/el/9/x86_64/>

Our RPM packages and repository metadata are signed using a GPG key with a user name of ‘Netdatabot’. The
current key fingerprint is `6588FDD7B14721FE7C3115E6F9177B5265F56346`. The associated public key can be fetched from
`https://repo.netdata.cloud/netdatabot.gpg.key`.

If you are explicitly configuring a system to use our repositories, the recommended setup is to download the
appropriate repository configuration package from https://repo.netdata.cloud/repos/repoconfig and install it
appropriate repository configuration package from <https://repo.netdata.cloud/repos/repoconfig> and install it
directly on the target system using the system package manager. This will ensure any packages needed to use the
repository are also installed, and will help enable a seamless transition if we ever need to change our infrastructure.

Expand All @@ -73,9 +70,9 @@ repository are also installed, and will help enable a seamless transition if we
> repository _should_ be pulled in automatically by our repository config packages, but if it is not you may need
> to manually install `epel-release` to be able to successfully install the Netdata packages.
## Manual setup of DEB packages.
## Manual setup of DEB packages

Netdata’s official DEB repositories are hosted at https://repo.netdata.cloud/repos. We provide four groups of
Netdata’s official DEB repositories are hosted at <https://repo.netdata.cloud/repos>. We provide four groups of
repositories at that top level:

- `stable`: Contains packages for stable releases of the Netdata Agent.
Expand Down Expand Up @@ -105,7 +102,7 @@ current key fingerprint is `6588FDD7B14721FE7C3115E6F9177B5265F56346`. The assoc
`https://repo.netdata.cloud/netdatabot.gpg.key`.

If you are explicitly configuring a system to use our repositories, the recommended setup is to download the
appropriate repository configuration package from https://repo.netdata.cloud/repos/repoconfig and install it
appropriate repository configuration package from <https://repo.netdata.cloud/repos/repoconfig> and install it
directly on the target system using the system package manager. This will ensure any packages needed to use the
repository are also installed, and will help enable a seamless transition if we ever need to change our infrastructure.

Expand Down
3 changes: 1 addition & 2 deletions packaging/maintainers/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ This page tracks the package maintainers for Netdata, for various operating syst

| System | URL | Core Developer | Package Maintainer
|:-:|:-:|:-:|:-:|
| macOS Homebrew Formula|[link](https://github.com/Homebrew/homebrew-core/blob/master/Formula/netdata.rb)|@vlvkobal|@rickard-von-essen
| macOS Homebrew Formula|[link](https://github.com/Homebrew/homebrew-core/blob/master/Formula/n/netdata.rb)|@vlvkobal|@rickard-von-essen

---

Expand All @@ -48,7 +48,6 @@ This page tracks the package maintainers for Netdata, for various operating syst

| Embedded Linux | Netdata Version | Maintainer | Related URL |
| :-: | :-: | :-: | :-- |
| ASUSTOR NAS | ? | William Lin | https://www.asustor.com/apps/app_detail?id=532 |
| OpenWRT | Release | @nitroshift | [openwrt package](https://github.com/openwrt/packages/tree/master/admin/netdata) |
| ReadyNAS | Release | @NAStools | https://github.com/nastools/netdata |
| QNAP | Release | QNAP_Stephane | https://forum.qnap.com/viewtopic.php?t=121518 |
Expand Down
2 changes: 1 addition & 1 deletion src/claim/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ Connecting a Node to a War Room:
terminal window. Press Enter to initiate the connection process.

> Note: When connecting from
> the [Nodes tab](https://github.com/netdata/netdata/blob/master/docs/dashboard/nodes-tab.md), the room parameter will
> the [Nodes tab](https://github.com/netdata/netdata/blob/master/docs/dashboards-and-charts/nodes-tab.md), the room parameter will
> be
> set to the current War Room.
Expand Down
2 changes: 0 additions & 2 deletions src/collectors/COLLECTORS.md
Original file line number Diff line number Diff line change
Expand Up @@ -441,8 +441,6 @@ If you don't see the app/service you'd like to monitor in this list:

- [BungeeCord](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/prometheus/integrations/bungeecord.md)

- [CS:GO](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/prometheus/integrations/cs:go.md)

- [Minecraft](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/prometheus/integrations/minecraft.md)

- [OpenRCT2](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/prometheus/integrations/openrct2.md)
Expand Down
2 changes: 1 addition & 1 deletion src/collectors/cgroups.plugin/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ The whole point for the additional pattern list, is to limit the number of times
pattern list, the script might be called thousands of times, depending on the number of cgroups available in the system.

The above pattern list is matched against the path of the cgroup. For matched cgroups, Netdata calls the
script [cgroup-name.sh](https://raw.githubusercontent.com/netdata/netdata/master/src/collectors/cgroups.plugin/cgroup-name.sh)
script [cgroup-name.sh](https://github.com/netdata/netdata/blob/master/src/collectors/cgroups.plugin/cgroup-name.sh.in)
to get its name. This script queries `docker`, `kubectl`, `podman`, or applies heuristics to find give a name for the
cgroup.

Expand Down
2 changes: 1 addition & 1 deletion src/collectors/charts.d.plugin/ap/metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ modules:
module_name: ap
monitored_instance:
name: Access Points
link: "https://learn.netdata.cloud/docs/data-collection/networking-stack-and-network-interfaces/linux-access-points"
link: ""
categories:
- data-collection.linux-systems.network-metrics
icon_filename: "network-wired.svg"
Expand Down
12 changes: 6 additions & 6 deletions src/collectors/ebpf.plugin/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,12 +44,12 @@ If your Agent is v1.22 or older, you may to enable the collector yourself.

To enable or disable the entire eBPF collector:

1. Navigate to the [Netdata config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#the-netdata-config-directory).
1. Navigate to the [Netdata config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).
```bash
cd /etc/netdata
```

2. Use the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#use-edit-config-to-edit-configuration-files) script to edit `netdata.conf`.
2. Use the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-netdataconf) script to edit `netdata.conf`.

```bash
./edit-config netdata.conf
Expand All @@ -69,11 +69,11 @@ You can configure the eBPF collector's behavior to fine-tune which metrics you r
To edit the `ebpf.d.conf`:
1. Navigate to the [Netdata config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#the-netdata-config-directory).
1. Navigate to the [Netdata config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).
```bash
cd /etc/netdata
```
2. Use the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#use-edit-config-to-edit-configuration-files) script to edit [`ebpf.d.conf`](https://github.com/netdata/netdata/blob/master/src/collectors/ebpf.plugin/ebpf.d.conf).
2. Use the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-netdataconf) script to edit [`ebpf.d.conf`](https://github.com/netdata/netdata/blob/master/src/collectors/ebpf.plugin/ebpf.d.conf).
```bash
./edit-config ebpf.d.conf
Expand Down Expand Up @@ -272,11 +272,11 @@ You can configure each thread of the eBPF data collector. This allows you to ove
To configure an eBPF thread:
1. Navigate to the [Netdata config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#the-netdata-config-directory).
1. Navigate to the [Netdata config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).
```bash
cd /etc/netdata
```
2. Use the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#use-edit-config-to-edit-configuration-files) script to edit a thread configuration file. The following configuration files are available:
2. Use the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-netdataconf) script to edit a thread configuration file. The following configuration files are available:
- `network.conf`: Configuration for the [`network` thread](#network-configuration). This config file overwrites the global options and also
lets you specify which network the eBPF collector monitors.
Expand Down
2 changes: 1 addition & 1 deletion src/collectors/profile.plugin/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ A user can specify:

## Configuration

Edit the `netdata.conf` configuration file using [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#use-edit-config-to-edit-configuration-files) from the [Netdata config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#the-netdata-config-directory), which is typically at `/etc/netdata`.
Edit the `netdata.conf` configuration file using [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-netdataconf) from the [Netdata config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#the-netdata-config-directory), which is typically at `/etc/netdata`.

Scroll down to the `[plugin:profile]` section to find the available options:

Expand Down
4 changes: 2 additions & 2 deletions src/collectors/python.d.plugin/anomalies/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,12 +68,12 @@ sudo ./edit-config python.d.conf
sudo systemctl restart netdata
```

The configuration for the anomalies collector defines how it will behave on your system and might take some experimentation with over time to set it optimally for your node. Out of the box, the config comes with some [sane defaults](https://www.netdata.cloud/blog/redefining-monitoring-netdata/) to get you started that try to balance the flexibility and power of the ML models with the goal of being as cheap as possible in term of cost on the node resources.
The configuration for the anomalies collector defines how it will behave on your system and might take some experimentation with over time to set it optimally for your node. Out of the box, the config comes with some [sane defaults](https://www.netdata.cloud/blog/redefining-monitoring-with-netdata/) to get you started that try to balance the flexibility and power of the ML models with the goal of being as cheap as possible in term of cost on the node resources.

_**Note**: If you are unsure about any of the below configuration options then it's best to just ignore all this and leave the `anomalies.conf` file alone to begin with. Then you can return to it later if you would like to tune things a bit more once the collector is running for a while and you have a feeling for its performance on your node._

Edit the `python.d/anomalies.conf` configuration file using `edit-config` from the your agent's [config
directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is usually at `/etc/netdata`.
directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md), which is usually at `/etc/netdata`.

```bash
cd /etc/netdata # Replace this path with your Netdata config directory, if different
Expand Down
Loading

0 comments on commit 9e23625

Please sign in to comment.