Fixing broken links found via linkchecker (#6983)
* Fixing links with workarounds and linkchecker * A few linter fixes
This commit is contained in:
Joel Hans
GitHub
parent
bfae683664
commit
2cb939c311
|
|
@ -14,7 +14,7 @@ Welcome! You've arrived at the documentation for Netdata. Use the links below to
|
|||
|
||||
</div>
|
||||
<div class="nav-getting-started">
|
||||
<a class="nav-button" href="docs/GettingStarted/">Getting started guide</a>
|
||||
<a class="nav-button" href="docs/getting-started/">Getting started guide</a>
|
||||
<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>
|
||||
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -10,7 +10,9 @@
|
|||
|
||||
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.
|
||||
|
||||
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).
|
||||
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](https://github.com/netdata/netdata/blob/c1f4c6cf503995cd4d896c5821b00d55afcbde87/.github/ISSUE_TEMPLATE/bug_report.md).
|
||||
|
||||
### When Should I Report a Vulnerability?
|
||||
|
||||
|
|
|
|||
|
|
@ -137,7 +137,7 @@ of `netdata.conf` from your Netdata):
|
|||
For kinesis backend `destination` should be set to an AWS region (for example, `us-east-1`).
|
||||
|
||||
The MongoDB backend doesn't use the `destination` option for its configuration. It uses the `mongodb.conf`
|
||||
[configuration file](mongodb/README.md) instead.
|
||||
[configuration file](../backends/mongodb/) instead.
|
||||
|
||||
- `data source = as collected`, or `data source = average`, or `data source = sum`, selects the kind of
|
||||
data that will be sent to the backend.
|
||||
|
|
|
|||
|
|
@ -62,7 +62,7 @@ QoS is about 2 features:
|
|||
|
||||
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.
|
||||
|
||||
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).
|
||||
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).
|
||||
|
||||
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.
|
||||
|
||||
|
|
|
|||
|
|
@ -19,7 +19,7 @@ followed by [Mastering Markdown](https://guides.github.com/features/mastering-ma
|
|||
|
||||
There are two ways to contribute to Netdata's documentation:
|
||||
|
||||
1. Edit documentation [directly in GitHub](#edit-documentation-directly-on-gitHub).
|
||||
1. Edit documentation [directly in GitHub](#edit-documentation-directly-on-github).
|
||||
2. Download the repository and [edit documentation locally](#edit-documentation-locally).
|
||||
|
||||
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
|
|||
You can find them at the top of every page.
|
||||
|
||||
Clicking on this icon will take you to the associated page in the `netdata/netdata` repository.
|
||||
Then click the small pencil icon on any documentation file (those ending in the `.md` [Markdown] extension) in the `netdata/netdata` repository.
|
||||
Then click the small pencil icon on any documentation file (those ending in the `.md` Markdown extension) in the `netdata/netdata` repository.
|
||||
|
||||
|
||||
|
||||
|
|
@ -109,7 +109,8 @@ folder and either name it `README.md` for generic documentation, or with another
|
|||
|
||||
At the root of the Netdata repository is a `docs/` folder. Inside this folder we place documentation that does not have
|
||||
a direct relationship to a specific component of Netdata. It's where we house our [getting started
|
||||
guide](../getting-started.md), guides on [running Netdata behind Nginx](../Running-behind-nginx.md), and more.
|
||||
guide](../../docs/getting-started.md), guides on [running Netdata behind Nginx](../../docs/Running-behind-nginx.md), and
|
||||
more.
|
||||
|
||||
If the documentation you're working on doesn't have a direct relaionship to a component of Netdata,
|
||||
it can be placed in this `docs/` folder.
|
||||
|
|
@ -168,7 +169,8 @@ cd docs/generator/build/
|
|||
python3 -m http.server 20000
|
||||
```
|
||||
|
||||
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!]).
|
||||
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!)).
|
||||
|
||||
Open your web browser and navigate to `http://localhost:20000`.
|
||||
If you replaced the port earlier, change it here as well.
|
||||
|
|
|
|||
|
|
@ -167,7 +167,7 @@ There are two quick ways to increase the depth of historical metrics: increase t
|
|||
that's enabled by default, or switch to the database engine.
|
||||
|
||||
We have a tutorial that walks you through both options: [**Changing how long Netdata stores
|
||||
metrics**](tutorials/longer-metrics-storage.md).
|
||||
metrics**](../docs/tutorials/longer-metrics-storage.md).
|
||||
|
||||
**What's next?**:
|
||||
|
||||
|
|
@ -181,9 +181,9 @@ metrics**](tutorials/longer-metrics-storage.md).
|
|||
If you have Netdata installed on multiple systems, you can have them all appear in the **My nodes** menu at the top-left
|
||||
corner of the dashboard.
|
||||
|
||||
To show all your servers in that menu, you need to [register for or sign in](netdata-cloud/signing-in.md) to [Netdata
|
||||
Cloud](netdata-cloud/) from each system. Each system will then appear in the **My nodes** menu, which you can use to
|
||||
navigate between your systems quickly.
|
||||
To show all your servers in that menu, you need to [register for or sign in](../docs/netdata-cloud/signing-in.md) to
|
||||
[Netdata Cloud](../docs/netdata-cloud/) from each system. Each system will then appear in the **My nodes** menu, which
|
||||
you can use to navigate between your systems quickly.
|
||||
|
||||
|
||||
|
|
@ -198,7 +198,7 @@ You can now seamlessly track performance anomalies across your entire infrastruc
|
|||
|
||||
- Read up on how the [Netdata Cloud registry works](../registry/), and what kind of data it stores and sends to your
|
||||
web browser.
|
||||
- Familiarize yourself with the [Nodes View](netdata-cloud/nodes-view.md)
|
||||
- Familiarize yourself with the [Nodes View](../docs/netdata-cloud/nodes-view.md)
|
||||
|
||||
## Start, stop, and restart Netdata
|
||||
|
||||
|
|
@ -228,6 +228,6 @@ Take a look at some more advanced features and configurations:
|
|||
- Improve security by putting Netdata behind an [Nginx proxy with SSL](Running-behind-nginx.md).
|
||||
|
||||
Or, learn more about how you can contribute to [Netdata core](../CONTRIBUTING.md) or our
|
||||
[documentation](contributing/contributing-documentation.md)!
|
||||
[documentation](../docs/contributing/contributing-documentation.md)!
|
||||
|
||||
[](<>)
|
||||
|
|
|
|||
|
|
@ -151,5 +151,5 @@ probably want to see it in action!
|
|||
For more information about how to pan charts to view historical metrics, see our documentation on [using
|
||||
charts](../../web/README.md#using-charts).
|
||||
|
||||
And if you'd now like to reduce Netdata's resource usage, view our [performance guide](../Performance.md) for our best
|
||||
practices on optimization.
|
||||
And if you'd now like to reduce Netdata's resource usage, view our [performance guide](../../docs/Performance.md) for
|
||||
our best practices on optimization.
|
||||
|
|
|
|||
|
|
@ -43,7 +43,7 @@ We provide docker images for the most common architectures. These are statistics
|
|||
|
||||
### Registry
|
||||
|
||||
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:
|
||||
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:
|
||||
|
||||
[](https://registry.my-netdata.io/#menu_netdata_submenu_registry) [](https://registry.my-netdata.io/#menu_netdata_submenu_registry) [](https://registry.my-netdata.io/#menu_netdata_submenu_registry)
|
||||
|
||||
|
|
@ -91,12 +91,12 @@ This is how it works:
|
|||
|
||||
|Function|Description|Documentation|
|
||||
|:------:|:----------|:-----------:|
|
||||
|**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)|
|
||||
|**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)|
|
||||
|**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)|
|
||||
|**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)|
|
||||
|**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/)|
|
||||
|**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/)|
|
||||
|**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/)|
|
||||
|**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/)|
|
||||
|**Archive**|A lockless independent worker is down-sampling the metrics and pushes them to **backend** time-series databases.|[`backends`](../backends/)|
|
||||
|**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)|
|
||||
|**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/)|
|
||||
|
||||
The result is a highly efficient, low latency system, supporting multiple readers and one writer on each metric.
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue