Skip to content

Commit 2cb939c

Browse files
authored
Fixing broken links found via linkchecker (netdata#6983)
* Fixing links with workarounds and linkchecker * A few linter fixes
1 parent bfae683 commit 2cb939c

File tree

8 files changed

+26
-22
lines changed

8 files changed

+26
-22
lines changed

DOCUMENTATION.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Welcome! You've arrived at the documentation for Netdata. Use the links below to
1414

1515
</div>
1616
<div class="nav-getting-started">
17-
<a class="nav-button" href="docs/GettingStarted/">Getting started guide</a>
17+
<a class="nav-button" href="docs/getting-started/">Getting started guide</a>
1818
<p>The perfect place for Netdata beginners to start. Learn how to access Netdata's dashboard, start and stop the service, basic configuration, and more.</p>
1919

2020
</div>

SECURITY.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@
1010

1111
We’re extremely grateful for security researchers and users that report vulnerabilities to Netdata Open Source Community. All reports are thoroughly investigated by a set of community volunteers.
1212

13-
To make a report, please create a post [here](https://groups.google.com/a/netdata.cloud/forum/#!newtopic/security) with the vulnerability details and the details expected for [all Netdata bug reports](.github/ISSUE_TEMPLATE/bug_report.md).
13+
To make a report, please create a post [here](https://groups.google.com/a/netdata.cloud/forum/#!newtopic/security) with
14+
the vulnerability details and the details expected for [all Netdata bug
15+
reports](https://github.com/netdata/netdata/blob/c1f4c6cf503995cd4d896c5821b00d55afcbde87/.github/ISSUE_TEMPLATE/bug_report.md).
1416

1517
### When Should I Report a Vulnerability?
1618

backends/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ of `netdata.conf` from your Netdata):
137137
For kinesis backend `destination` should be set to an AWS region (for example, `us-east-1`).
138138

139139
The MongoDB backend doesn't use the `destination` option for its configuration. It uses the `mongodb.conf`
140-
[configuration file](mongodb/README.md) instead.
140+
[configuration file](../backends/mongodb/) instead.
141141

142142
- `data source = as collected`, or `data source = average`, or `data source = sum`, selects the kind of
143143
data that will be sent to the backend.

collectors/tc.plugin/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ QoS is about 2 features:
6262

6363
When your system is under a DDoS attack, it will get a lot more bandwidth compared to the one it can handle and probably your applications will crash. Setting a limit on the inbound traffic using QoS, will protect your servers (throttle the requests) and depending on the size of the attack may allow your legitimate users to access the server, while the attack is taking place.
6464

65-
Using QoS together with a [SYNPROXY](../proc.plugin/README.md#linux-anti-ddos) will provide a great degree of protection against most DDoS attacks. Actually when I wrote that article, a few folks tried to DDoS the Netdata demo site to see in real-time the SYNPROXY operation. They did not do it right, but anyway a great deal of requests reached the Netdata server. What saved Netdata was QoS. The Netdata demo server has QoS installed, so the requests were throttled and the server did not even reach the point of resource starvation. Read about it [here](../proc.plugin/README.md#linux-anti-ddos).
65+
Using QoS together with a [SYNPROXY](../../collectors/proc.plugin/README.md) will provide a great degree of protection against most DDoS attacks. Actually when I wrote that article, a few folks tried to DDoS the Netdata demo site to see in real-time the SYNPROXY operation. They did not do it right, but anyway a great deal of requests reached the Netdata server. What saved Netdata was QoS. The Netdata demo server has QoS installed, so the requests were throttled and the server did not even reach the point of resource starvation. Read about it [here](../../collectors/proc.plugin/README.md).
6666

6767
On top of all these, QoS is extremely light. You will configure it once, and this is it. It will not bother you again and it will not use any noticeable CPU resources, especially on application and database servers.
6868

docs/contributing/contributing-documentation.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ followed by [Mastering Markdown](https://guides.github.com/features/mastering-ma
1919

2020
There are two ways to contribute to Netdata's documentation:
2121

22-
1. Edit documentation [directly in GitHub](#edit-documentation-directly-on-gitHub).
22+
1. Edit documentation [directly in GitHub](#edit-documentation-directly-on-github).
2323
2. Download the repository and [edit documentation locally](#edit-documentation-locally).
2424

2525
Editing in GitHub is a simpler process and is perfect for quick edits to a single document,
@@ -45,7 +45,7 @@ Start editing documentation on GitHub by clicking the small pencil icon on any p
4545
You can find them at the top of every page.
4646

4747
Clicking on this icon will take you to the associated page in the `netdata/netdata` repository.
48-
Then click the small pencil icon on any documentation file (those ending in the `.md` [Markdown] extension) in the `netdata/netdata` repository.
48+
Then click the small pencil icon on any documentation file (those ending in the `.md` Markdown extension) in the `netdata/netdata` repository.
4949

5050
![A screenshot of editing a Markdown file directly in the Netdata repository](https://user-images.githubusercontent.com/1153921/59637188-10426d00-910a-11e9-99f2-ec564d6fb7d5.png)
5151

@@ -109,7 +109,8 @@ folder and either name it `README.md` for generic documentation, or with another
109109

110110
At the root of the Netdata repository is a `docs/` folder. Inside this folder we place documentation that does not have
111111
a direct relationship to a specific component of Netdata. It's where we house our [getting started
112-
guide](../getting-started.md), guides on [running Netdata behind Nginx](../Running-behind-nginx.md), and more.
112+
guide](../../docs/getting-started.md), guides on [running Netdata behind Nginx](../../docs/Running-behind-nginx.md), and
113+
more.
113114

114115
If the documentation you're working on doesn't have a direct relaionship to a component of Netdata,
115116
it can be placed in this `docs/` folder.
@@ -168,7 +169,8 @@ cd docs/generator/build/
168169
python3 -m http.server 20000
169170
```
170171

171-
Feel free to replace the port number you want this web server to listen on (port `20000` in this case [only one higher than the agent!]).
172+
Feel free to replace the port number you want this web server to listen on (port `20000` in this case (only one higher
173+
than the agent!)).
172174

173175
Open your web browser and navigate to `http://localhost:20000`.
174176
If you replaced the port earlier, change it here as well.

docs/getting-started.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ There are two quick ways to increase the depth of historical metrics: increase t
167167
that's enabled by default, or switch to the database engine.
168168

169169
We have a tutorial that walks you through both options: [**Changing how long Netdata stores
170-
metrics**](tutorials/longer-metrics-storage.md).
170+
metrics**](../docs/tutorials/longer-metrics-storage.md).
171171

172172
**What's next?**:
173173

@@ -181,9 +181,9 @@ metrics**](tutorials/longer-metrics-storage.md).
181181
If you have Netdata installed on multiple systems, you can have them all appear in the **My nodes** menu at the top-left
182182
corner of the dashboard.
183183

184-
To show all your servers in that menu, you need to [register for or sign in](netdata-cloud/signing-in.md) to [Netdata
185-
Cloud](netdata-cloud/) from each system. Each system will then appear in the **My nodes** menu, which you can use to
186-
navigate between your systems quickly.
184+
To show all your servers in that menu, you need to [register for or sign in](../docs/netdata-cloud/signing-in.md) to
185+
[Netdata Cloud](../docs/netdata-cloud/) from each system. Each system will then appear in the **My nodes** menu, which
186+
you can use to navigate between your systems quickly.
187187

188188
![Animated GIF of the My Nodes menu in
189189
action](https://user-images.githubusercontent.com/1153921/64389938-9aa7b800-cff9-11e9-9653-a77e791811ad.gif)
@@ -198,7 +198,7 @@ You can now seamlessly track performance anomalies across your entire infrastruc
198198

199199
- Read up on how the [Netdata Cloud registry works](../registry/), and what kind of data it stores and sends to your
200200
web browser.
201-
- Familiarize yourself with the [Nodes View](netdata-cloud/nodes-view.md)
201+
- Familiarize yourself with the [Nodes View](../docs/netdata-cloud/nodes-view.md)
202202

203203
## Start, stop, and restart Netdata
204204

@@ -228,6 +228,6 @@ Take a look at some more advanced features and configurations:
228228
- Improve security by putting Netdata behind an [Nginx proxy with SSL](Running-behind-nginx.md).
229229

230230
Or, learn more about how you can contribute to [Netdata core](../CONTRIBUTING.md) or our
231-
[documentation](contributing/contributing-documentation.md)!
231+
[documentation](../docs/contributing/contributing-documentation.md)!
232232

233233
[![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%2Fdocs%2FGettingStarted&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)

docs/tutorials/longer-metrics-storage.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -151,5 +151,5 @@ probably want to see it in action!
151151
For more information about how to pan charts to view historical metrics, see our documentation on [using
152152
charts](../../web/README.md#using-charts).
153153

154-
And if you'd now like to reduce Netdata's resource usage, view our [performance guide](../Performance.md) for our best
155-
practices on optimization.
154+
And if you'd now like to reduce Netdata's resource usage, view our [performance guide](../../docs/Performance.md) for
155+
our best practices on optimization.

docs/what-is-netdata.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ We provide docker images for the most common architectures. These are statistics
4343

4444
### Registry
4545

46-
When you install multiple Netdata, they are integrated into **one distributed application**, via a [Netdata registry](../registry/#registry). This is a web browser feature and it allows us to count the number of unique users and unique Netdata servers installed. The following information comes from the global public Netdata registry we run:
46+
When you install multiple Netdata, they are integrated into **one distributed application**, via a [Netdata registry](../registry/). This is a web browser feature and it allows us to count the number of unique users and unique Netdata servers installed. The following information comes from the global public Netdata registry we run:
4747

4848
[![User Base](https://registry.my-netdata.io/api/v1/badge.svg?chart=netdata.registry_entries&dimensions=persons&label=user%20base&units=M&value_color=blue&precision=2&divide=1000000&v43)](https://registry.my-netdata.io/#menu_netdata_submenu_registry) [![Monitored Servers](https://registry.my-netdata.io/api/v1/badge.svg?chart=netdata.registry_entries&dimensions=machines&label=servers%20monitored&units=k&divide=1000&value_color=orange&precision=2&v43)](https://registry.my-netdata.io/#menu_netdata_submenu_registry) [![Sessions Served](https://registry.my-netdata.io/api/v1/badge.svg?chart=netdata.registry_sessions&label=sessions%20served&units=M&value_color=yellowgreen&precision=2&divide=1000000&v43)](https://registry.my-netdata.io/#menu_netdata_submenu_registry)
4949

@@ -91,12 +91,12 @@ This is how it works:
9191

9292
|Function|Description|Documentation|
9393
|:------:|:----------|:-----------:|
94-
|**Collect**|Multiple independent data collection workers are collecting metrics from their sources using the optimal protocol for each application and push the metrics to the database. Each data collection worker has lockless write access to the metrics it collects.|[`collectors`](../collectors/#data-collection-plugins)|
95-
|**Store**|Metrics are stored in RAM in a round robin database (ring buffer), using a custom made floating point number for minimal footprint.|[`database`](../database/#database)|
96-
|**Check**|A lockless independent watchdog is evaluating **health checks** on the collected metrics, triggers alarms, maintains a health transaction log and dispatches alarm notifications.|[`health`](../health/#health-monitoring)|
97-
|**Stream**|An lockless independent worker is streaming metrics, in full detail and in real-time, to remote Netdata servers, as soon as they are collected.|[`streaming`](../streaming/#streaming-and-replication)|
94+
|**Collect**|Multiple independent data collection workers are collecting metrics from their sources using the optimal protocol for each application and push the metrics to the database. Each data collection worker has lockless write access to the metrics it collects.|[`collectors`](../collectors/)|
95+
|**Store**|Metrics are stored in RAM in a round robin database (ring buffer), using a custom made floating point number for minimal footprint.|[`database`](../database/)|
96+
|**Check**|A lockless independent watchdog is evaluating **health checks** on the collected metrics, triggers alarms, maintains a health transaction log and dispatches alarm notifications.|[`health`](../health/)|
97+
|**Stream**|An lockless independent worker is streaming metrics, in full detail and in real-time, to remote Netdata servers, as soon as they are collected.|[`streaming`](../streaming/)|
9898
|**Archive**|A lockless independent worker is down-sampling the metrics and pushes them to **backend** time-series databases.|[`backends`](../backends/)|
99-
|**Query**|Multiple independent workers are attached to the [internal web server](../web/server/#web-server), servicing API requests, including [data queries](../web/api/queries/#database-queries).|[`web/api`](../web/api/#api)|
99+
|**Query**|Multiple independent workers are attached to the [internal web server](../web/server/), servicing API requests, including [data queries](../web/api/queries/README.md).|[`web/api`](../web/api/)|
100100

101101
The result is a highly efficient, low latency system, supporting multiple readers and one writer on each metric.
102102

0 commit comments

Comments
 (0)