summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorIlya Mashchenko <ilya@netdata.cloud>2021-12-20 16:21:01 +0300
committerGitHub <noreply@github.com>2021-12-20 16:21:01 +0300
commit78c2af15478ea47e436ed58f0db827e5f37ba26d (patch)
tree7afc25a81e33fff26aa844409d6bbb329ca106a0 /docs
parent1246d721f4959e1d1af76011c3a39b1986ea6831 (diff)
fix(docs): unresolved file references (#11903)
Diffstat (limited to 'docs')
-rw-r--r--docs/anonymous-statistics.md2
-rw-r--r--docs/collect/application-metrics.md2
-rw-r--r--docs/collect/system-metrics.md2
-rw-r--r--docs/configure/common-changes.md2
-rw-r--r--docs/configure/secure-nodes.md2
-rw-r--r--docs/contributing/contributing-documentation.md4
-rw-r--r--docs/contributing/style-guide.md2
-rw-r--r--docs/dashboard/customize.mdx2
-rw-r--r--docs/dashboard/dimensions-contexts-families.mdx2
-rw-r--r--docs/export/external-databases.md2
-rw-r--r--docs/getting-started.md12
-rw-r--r--docs/guides/longer-metrics-storage.md2
-rw-r--r--docs/guides/monitor/pi-hole-raspberry-pi.md2
-rw-r--r--docs/guides/monitor/stop-notifications-alarms.md2
-rw-r--r--docs/guides/step-by-step/step-05.md2
-rw-r--r--docs/guides/step-by-step/step-99.md2
-rw-r--r--docs/metrics-storage-management/enable-streaming.mdx4
-rw-r--r--docs/monitor/configure-alarms.md2
-rw-r--r--docs/monitor/enable-notifications.md2
-rw-r--r--docs/quickstart/infrastructure.md2
20 files changed, 27 insertions, 27 deletions
diff --git a/docs/anonymous-statistics.md b/docs/anonymous-statistics.md
index 75e586bd41..5c82e05372 100644
--- a/docs/anonymous-statistics.md
+++ b/docs/anonymous-statistics.md
@@ -91,7 +91,7 @@ update. You can also export the environment variable `DO_NOT_TRACK` with a non-z
When using Docker, **set your `DO_NOT_TRACK` environment variable to `1`.** You can set this variable with the following
command: `export DO_NOT_TRACK=1`. When creating a container using Netdata's [Docker
-image](/packaging/docker/README.md#run-the-agent-with-the-docker-command) for the first time, this variable will disable
+image](/packaging/docker/README.md#create-a-new-netdata-agent-container) for the first time, this variable will disable
the anonymous statistics script inside of the container.
Each of these opt-out processes does the following:
diff --git a/docs/collect/application-metrics.md b/docs/collect/application-metrics.md
index fbc0ae249c..4fb9ed6abb 100644
--- a/docs/collect/application-metrics.md
+++ b/docs/collect/application-metrics.md
@@ -29,7 +29,7 @@ Our most popular application collectors:
rows in less than half a second.
- [MySQL](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/mysql/): Collect database global,
replication, and per-user statistics.
-- [Redis](/collectors/python.d.plugin/redis/): Monitor database status by reading the server's response to the `INFO`
+- [Redis](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/redis): Monitor database status by reading the server's response to the `INFO`
command.
- [Apache](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/apache/): Collect Apache web
server performance metrics via the `server-status?auto` endpoint.
diff --git a/docs/collect/system-metrics.md b/docs/collect/system-metrics.md
index 599d6f5832..14e2cc2aa3 100644
--- a/docs/collect/system-metrics.md
+++ b/docs/collect/system-metrics.md
@@ -30,7 +30,7 @@ eBPF collector to analyze how and when a process accesses files, when it makes s
creating zombie processes, and more.
While the above plugins and associated collectors are the most important for system metrics, there are many others. You
-can find all system collectors in our [supported collectors list](/collectors/COLLECTORS.md#system-metrics).
+can find all system collectors in our [supported collectors list](/collectors/COLLECTORS.md#system-collectors).
## Collect Windows system metrics
diff --git a/docs/configure/common-changes.md b/docs/configure/common-changes.md
index 6749384acd..cf2e5d78a1 100644
--- a/docs/configure/common-changes.md
+++ b/docs/configure/common-changes.md
@@ -31,7 +31,7 @@ section](/daemon/config/README.md#global-section-options) of `netdata.conf`.
```
Read our doc on [increasing long-term metrics storage](/docs/store/change-metrics-storage.md) for details, including a
-[calculator](/docs/store/change-metrics-storage.md#calculate-the-system-resources-RAM-disk-space-needed-to-store-metrics)
+[calculator](/docs/store/change-metrics-storage.md#calculate-the-system-resources-ram-disk-space-needed-to-store-metrics)
to help you determine the exact settings for your desired retention period.
### Reduce the data collection frequency
diff --git a/docs/configure/secure-nodes.md b/docs/configure/secure-nodes.md
index 180ffe357d..02057ab9e5 100644
--- a/docs/configure/secure-nodes.md
+++ b/docs/configure/secure-nodes.md
@@ -11,7 +11,7 @@ internet at large, anyone can access the dashboard and your node's metrics at `h
so that the local dashboard was immediately accessible to users, and so that we don't dictate how professionals set up
and secure their infrastructures.
-Despite this design decision, your [data](/docs/netdata-security.md#your-data-are-safe-with-netdata) and your
+Despite this design decision, your [data](/docs/netdata-security.md#your-data-is-safe-with-netdata) and your
[systems](/docs/netdata-security.md#your-systems-are-safe-with-netdata) are safe with Netdata. Netdata is read-only,
cannot do anything other than present metrics, and runs without special/`sudo` privileges. Also, the local dashboard
only exposes chart metadata and metric values, not raw data.
diff --git a/docs/contributing/contributing-documentation.md b/docs/contributing/contributing-documentation.md
index 22df9fc3e1..76fc609d5f 100644
--- a/docs/contributing/contributing-documentation.md
+++ b/docs/contributing/contributing-documentation.md
@@ -18,7 +18,7 @@ The Netdata team aggregates and publishes all documentation at [learn.netdata.cl
## Before you get started
Anyone interested in contributing to documentation should first read the [Netdata style
-guide](/docs/contributing/style-guide.md) and the [Netdata Community Code of Conduct](/CODE_OF_CONDUCT.md).
+guide](/docs/contributing/style-guide.md) and the [Netdata Community Code of Conduct](https://learn.netdata.cloud/contribute/code-of-conduct).
Netdata's documentation uses Markdown syntax. If you're not familiar with Markdown, read the [Mastering
Markdown](https://guides.github.com/features/mastering-markdown/) guide from GitHub for the basics on creating
@@ -92,7 +92,7 @@ request based on the changes you made in the new branch of your fork.
## Making a pull request
-Pull requests (PRs) should be concise and informative. See our [PR guidelines](/CONTRIBUTING.md#pr-guidelines) for
+Pull requests (PRs) should be concise and informative. See our [PR guidelines](https://learn.netdata.cloud/contribute/handbook#pr-guidelines) for
specifics.
- The title must follow the [imperative mood](https://en.wikipedia.org/wiki/Imperative_mood) and be no more than ~50
diff --git a/docs/contributing/style-guide.md b/docs/contributing/style-guide.md
index 625237bc07..025b45f64f 100644
--- a/docs/contributing/style-guide.md
+++ b/docs/contributing/style-guide.md
@@ -421,7 +421,7 @@ In Markdown, use the standard image syntax, `![]()`, and place the alt text betw
using our logo:
```markdown
-![The Netdata logo](../../web/gui/images/netdata-logomark.svg)
+![The Netdata logo](/web/gui/static/img/netdata-logomark.svg)
```
Reference in-product text, code samples, and terminal output with actual text content, not screen captures or other
diff --git a/docs/dashboard/customize.mdx b/docs/dashboard/customize.mdx
index 2c82a1c50e..d203379110 100644
--- a/docs/dashboard/customize.mdx
+++ b/docs/dashboard/customize.mdx
@@ -25,7 +25,7 @@ Here are a few popular settings:
### Change chart legend position
Find this setting under the **Visual** tab. By default, Netdata places the [legend of
-dimensions](/docs/dashboard/dimensions-contexts-families.mdx#dimensions) _below_ charts. Click this toggle to
+dimensions](/docs/dashboard/dimensions-contexts-families.mdx#dimension) _below_ charts. Click this toggle to
move the legend to the _right_ of charts.
### Change theme
diff --git a/docs/dashboard/dimensions-contexts-families.mdx b/docs/dashboard/dimensions-contexts-families.mdx
index da9aad78f9..0c6dd2adc9 100644
--- a/docs/dashboard/dimensions-contexts-families.mdx
+++ b/docs/dashboard/dimensions-contexts-families.mdx
@@ -26,7 +26,7 @@ utilization is represented as a percentage, disk I/O as `MiB/s`, and available R
Beneath every chart (or on the right-side if you configure the dashboard) is a legend of dimensions. When there are
multiple dimensions, you'll see a different entry in the legend for each dimension.
-The **Apps CPU Time** chart (with the [context](#contexts) `apps.cpu`), which visualizes CPU utilization of
+The **Apps CPU Time** chart (with the [context](#context) `apps.cpu`), which visualizes CPU utilization of
different types of processes/services/applications on your node, always provides a vibrant example of a chart with
multiple dimensions.
diff --git a/docs/export/external-databases.md b/docs/export/external-databases.md
index 309b03a878..67a55baadb 100644
--- a/docs/export/external-databases.md
+++ b/docs/export/external-databases.md
@@ -51,7 +51,7 @@ documentation and the [enabling a connector](/docs/export/enable-connector.md) d
- **KairosDB**: [Graphite](/exporting/graphite/README.md), [OpenTSDB](/exporting/opentsdb/README.md)
- **M3DB**: [Prometheus remote write](/exporting/prometheus/remote_write/README.md)
- **MetricFire**: [Prometheus remote write](/exporting/prometheus/remote_write/README.md)
-- **MongoDB**: [MongoDB](/exporting/mongodb/)
+- **MongoDB**: [MongoDB](/exporting/mongodb/README.md)
- **New Relic**: [Prometheus remote write](/exporting/prometheus/remote_write/README.md)
- **OpenTSDB**: [OpenTSDB](/exporting/opentsdb/README.md), [Prometheus remote
write](/exporting/prometheus/remote_write/README.md)
diff --git a/docs/getting-started.md b/docs/getting-started.md
index 2d1f3de6d9..2dd045f090 100644
--- a/docs/getting-started.md
+++ b/docs/getting-started.md
@@ -28,7 +28,7 @@ dashboard](https://user-images.githubusercontent.com/1153921/80825153-abaec600-8
**What's next?**:
-- Read more about the [standard Netdata dashboard](/web/gui/).
+- Read more about the [standard Netdata dashboard](/web/gui/README.md).
- Learn all the specifics of [using charts](/web/README.md#using-charts) or the differences between [charts,
context, and families](/web/README.md#charts-contexts-families).
@@ -51,9 +51,9 @@ Once you save your changes, [restart Netdata](#start-stop-and-restart-netdata) t
- [Change how long Netdata stores metrics](#change-how-long-netdata-stores-metrics) by changing the `page cache size`
and `dbengine disk space` settings in `netdata.conf`.
-- Move Netdata's dashboard to a [different port](/web/server/) or enable TLS/HTTPS
+- Move Netdata's dashboard to a [different port](/web/server/README.md) or enable TLS/HTTPS
encryption.
-- See all the `netdata.conf` options in our [daemon configuration documentation](/daemon/config/).
+- See all the `netdata.conf` options in our [daemon configuration documentation](/daemon/config/README.md).
- Run your own [registry](/registry/README.md#run-your-own-registry).
## Change how long Netdata stores metrics
@@ -86,7 +86,7 @@ Netdata](#start-stop-and-restart-netdata).
However, auto-detection only works if you installed the source using its standard installation procedure. If Netdata
isn't collecting metrics after a restart, your source probably isn't configured correctly. Look at the [external plugin
-documentation](/collectors/plugins.d/) to find the appropriate module for your source. Those pages will contain
+documentation](/collectors/plugins.d/README.md) to find the appropriate module for your source. Those pages will contain
more information about how to configure your source for auto-detection.
Some modules, like `chrony`, are disabled by default and must be enabled manually for auto-detection to work.
@@ -186,7 +186,7 @@ Find the `SEND_EMAIL="YES"` line and change it to `SEND_EMAIL="NO"`.
- Follow the [health quickstart](/health/QUICKSTART.md) to locate and edit existing health entities, and then
create your own.
- See all the alarm options via the [health configuration reference](/health/REFERENCE.md).
-- Add a new notification method, like [Slack](/health/notifications/slack/).
+- Add a new notification method, like [Slack](/health/notifications/slack/README.md).
## Monitor multiple systems with Netdata Cloud
@@ -230,7 +230,7 @@ Take a look at some more advanced features and configurations:
- Enable long-term archiving of Netdata metrics via [exporting engine](/exporting/README.md) to time-series databases.
- Improve security by putting Netdata behind an [Nginx proxy with SSL](/docs/Running-behind-nginx.md).
-Or, learn more about how you can contribute to [Netdata core](/CONTRIBUTING.md) or our
+Or, learn more about how you can contribute to [Netdata core](/README.md#contribute) or our
[documentation](/docs/contributing/contributing-documentation.md)!
[![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%2Fgetting-started&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)
diff --git a/docs/guides/longer-metrics-storage.md b/docs/guides/longer-metrics-storage.md
index 85b397f6d4..b682125f5c 100644
--- a/docs/guides/longer-metrics-storage.md
+++ b/docs/guides/longer-metrics-storage.md
@@ -57,7 +57,7 @@ compressed metrics. The default settings retain about two day's worth of metrics
every second.
[**See our database engine
-calculator**](/docs/store/change-metrics-storage.md#calculate-the-system-resources-RAM-disk-space-needed-to-store-metrics)
+calculator**](/docs/store/change-metrics-storage.md#calculate-the-system-resources-ram-disk-space-needed-to-store-metrics)
to help you correctly set `dbengine multihost disk space` based on your needs. The calculator gives an accurate estimate
based on how many child nodes you have, how many metrics your Agent collects, and more.
diff --git a/docs/guides/monitor/pi-hole-raspberry-pi.md b/docs/guides/monitor/pi-hole-raspberry-pi.md
index dc5e0b314e..8ac25b8cb1 100644
--- a/docs/guides/monitor/pi-hole-raspberry-pi.md
+++ b/docs/guides/monitor/pi-hole-raspberry-pi.md
@@ -137,7 +137,7 @@ more than 256.
```
Use our [database sizing
-calculator](/docs/store/change-metrics-storage.md#calculate-the-system-resources-RAM-disk-space-needed-to-store-metrics)
+calculator](/docs/store/change-metrics-storage.md#calculate-the-system-resources-ram-disk-space-needed-to-store-metrics)
and [guide on storing historical metrics](/docs/guides/longer-metrics-storage.md) to help you determine the right
setting for your Raspberry Pi.
diff --git a/docs/guides/monitor/stop-notifications-alarms.md b/docs/guides/monitor/stop-notifications-alarms.md
index 587880ab11..ad054d5c79 100644
--- a/docs/guides/monitor/stop-notifications-alarms.md
+++ b/docs/guides/monitor/stop-notifications-alarms.md
@@ -80,7 +80,7 @@ You can add `to: silent` to any alarm you'd rather not bother you with notificat
You should now know the fundamentals behind silencing any individual alarm in Netdata.
To learn about _all_ of Netdata's health configuration possibilities, visit the [health reference
-guide](/health/REFERENCE.md), or check out other [tutorials on health monitoring](/health/README.md#tutorials).
+guide](/health/REFERENCE.md), or check out other [tutorials on health monitoring](/health/README.md#guides).
Or, take better control over how you get notified about alarms via the [notification
system](/health/notifications/README.md).
diff --git a/docs/guides/step-by-step/step-05.md b/docs/guides/step-by-step/step-05.md
index 8a4d084e4e..c0b6226182 100644
--- a/docs/guides/step-by-step/step-05.md
+++ b/docs/guides/step-by-step/step-05.md
@@ -224,7 +224,7 @@ Health alarms, while great on their own, are pretty useless without some way of
That's why Netdata comes with a notification system that supports more than a dozen services, such as email, Slack,
Discord, PagerDuty, Twilio, Amazon SNS, and much more.
-To see all the supported systems, visit our [notifications documentation](/health/notifications/).
+To see all the supported systems, visit our [notifications documentation](/health/notifications/README.md).
We'll cover email and Slack notifications here, but with this knowledge you should be able to enable any other type of
notifications instead of or in addition to these.
diff --git a/docs/guides/step-by-step/step-99.md b/docs/guides/step-by-step/step-99.md
index 3b893d5a3b..06a826a15a 100644
--- a/docs/guides/step-by-step/step-99.md
+++ b/docs/guides/step-by-step/step-99.md
@@ -44,7 +44,7 @@ If that feels like too much possibility to you, why not one of these options:
- Share your experience with Netdata and this guide. Be sure to [@mention](https://twitter.com/linuxnetdata) us on
Twitter!
- Contribute to what we do. Browse our [open issues](https://github.com/netdata/netdata/issues) and check out out
- [contributions doc](/CONTRIBUTING.md) for ideas of how you can pitch in.
+ [contributions doc](/README.md#contribute) for ideas of how you can pitch in.
We can't wait to see what you monitor next! Bon voyage! ⛵
diff --git a/docs/metrics-storage-management/enable-streaming.mdx b/docs/metrics-storage-management/enable-streaming.mdx
index d97a8a769d..a737b07b61 100644
--- a/docs/metrics-storage-management/enable-streaming.mdx
+++ b/docs/metrics-storage-management/enable-streaming.mdx
@@ -76,7 +76,7 @@ method](/docs/configure/start-stop-restart.md) for your system.
While encrypting the connection between your parent and child nodes is recommended for security, it's not required to
get started. If you're not interested in encryption, skip ahead to [view streamed
-metrics](#view-streamed-metrics-in-netdata-s-dashboard).
+metrics](#view-streamed-metrics-in-netdatas-dashboard).
In this example, we'll use self-signed certificates.
@@ -135,7 +135,7 @@ Now that you have a basic streaming setup with replication, you may want to twea
child database, disable the child dashboard, or enable SSL on the streaming connection between the parent and child.
See the [streaming reference
-doc](/docs/metrics-storage-management/reference-streaming.mdx#supported-streaming-configurations) for details about
+doc](/docs/metrics-storage-management/reference-streaming.mdx#examples) for details about
other possible configurations.
When using Netdata's default TSDB (`dbengine`), the parent node maintains separate, parallel databases for itself and
diff --git a/docs/monitor/configure-alarms.md b/docs/monitor/configure-alarms.md
index 2a977955b8..563e615608 100644
--- a/docs/monitor/configure-alarms.md
+++ b/docs/monitor/configure-alarms.md
@@ -117,7 +117,7 @@ Let's look into each of the lines to see how they create a working health entity
- `every`: How often to perform the `lookup` calculation to decide whether or not to trigger this alarm.
- `warn`/`crit`: The value at which Netdata should trigger a warning or critical alarm. This example uses simple
syntax, but most pre-configured health entities use
- [hysteresis](/health/REFERENCE.md#special-usage-of-the-conditional-operator) to avoid superfluous notifications.
+ [hysteresis](/health/REFERENCE.md#special-use-of-the-conditional-operator) to avoid superfluous notifications.
- `info`: A description of the alarm, which will appear in the dashboard and notifications.
In human-readable format:
diff --git a/docs/monitor/enable-notifications.md b/docs/monitor/enable-notifications.md
index e5b5a6f265..d0ff04d99d 100644
--- a/docs/monitor/enable-notifications.md
+++ b/docs/monitor/enable-notifications.md
@@ -94,7 +94,7 @@ want to see alarm notifications from Netdata. Click the green **Add to Slack** b
On the following page, you'll receive a **Webhook URL**. That's what you'll need to configure Netdata, so keep it handy.
-Navigate to your [Netdata config directory](/docs/configure/nodes.md#netdata-config-directory) and use `edit-config` to
+Navigate to your [Netdata config directory](/docs/configure/nodes.md#the-netdata-config-directory) and use `edit-config` to
open the `health_alarm_notify.conf` file:
```bash
diff --git a/docs/quickstart/infrastructure.md b/docs/quickstart/infrastructure.md
index ed136fe12f..ea803cf136 100644
--- a/docs/quickstart/infrastructure.md
+++ b/docs/quickstart/infrastructure.md
@@ -91,7 +91,7 @@ single-node dashboards in Netdata Cloud to drill down on specific issues, scrub
historical data, and see like metrics presented meaningfully to help you troubleshoot performance problems.
Read about the process in the [infrastructure
-overview](/docs/visualize/overview-infrastructure.md#single-node-dashboards) doc, then learn about [interacting with
+overview](/docs/visualize/overview-infrastructure.md#drill-down-with-single-node-dashboards) doc, then learn about [interacting with
dashboards and charts](/docs/visualize/interact-dashboards-charts.md) to get the most from all of Netdata's real-time
metrics.