From 833252b8db7d5544dcaf9e7b7ea26194e1f1521e Mon Sep 17 00:00:00 2001 From: Joel Hans Date: Mon, 10 May 2021 13:43:44 -0700 Subject: Fix broken links in various docs (#11109) --- collectors/python.d.plugin/README.md | 2 +- daemon/config/README.md | 2 +- docs/contributing/contributing-documentation.md | 2 +- docs/dashboard/dimensions-contexts-families.mdx | 13 ++++++------- docs/dashboard/select-timeframes.mdx | 2 +- packaging/docker/README.md | 5 ++--- 6 files changed, 12 insertions(+), 14 deletions(-) diff --git a/collectors/python.d.plugin/README.md b/collectors/python.d.plugin/README.md index f73f9cde08..9170350fb8 100644 --- a/collectors/python.d.plugin/README.md +++ b/collectors/python.d.plugin/README.md @@ -127,7 +127,7 @@ CHART = { ]} ``` -All names are better explained in the [External Plugins](../) section. +All names are better explained in the [External Plugins](/collectors/plugins.d/README.md) section. Parameters like `priority` and `update_every` are handled by `python.d.plugin`. ### `Service` class diff --git a/daemon/config/README.md b/daemon/config/README.md index b1e790a214..cc755af78a 100644 --- a/daemon/config/README.md +++ b/daemon/config/README.md @@ -50,7 +50,7 @@ Please note that your data history will be lost if you have modified `history` p | setting|default|info||| |:-----:|:-----:|:---|---|---| | process scheduling policy|`keep`|See [Netdata process scheduling policy](/daemon/README.md#netdata-process-scheduling-policy)||| -| OOM score|`1000`|See [OOM score](../#oom-score)||| +| OOM score|`1000`|See [OOM score](/daemon/README.md#oom-score)||| | glibc malloc arena max for plugins|`1`|See [Virtual memory](/daemon/README.md#virtual-memory).||| | glibc malloc arena max for Netdata|`1`|See [Virtual memory](/daemon/README.md#virtual-memory).||| | hostname|auto-detected|The hostname of the computer running Netdata.||| diff --git a/docs/contributing/contributing-documentation.md b/docs/contributing/contributing-documentation.md index 44be92299f..22df9fc3e1 100644 --- a/docs/contributing/contributing-documentation.md +++ b/docs/contributing/contributing-documentation.md @@ -37,7 +37,7 @@ Netdata's documentation is separated into four sections. - **Netdata Agent reference**: Reference documentation for the open-source Netdata Agent. - Stored in various `.md` files within the `netdata/netdata` repository alongside the code responsible for that feature. For example, the database engine's reference documentation is at `/database/engine/README.md`. - - Published at [`https://learn.netdata.cloud/docs/agent`](https://learn.netdata.cloud/docs/agent). + - Published under the **Reference** section in the Netdata Learn sidebar. - **Netdata Cloud reference**: Reference documentation for the closed-source Netdata Cloud web application. - Stored in a private GitHub repository and not editable by the community. - Published at [`https://learn.netdata.cloud/docs/cloud`](https://learn.netdata.cloud/docs/cloud). diff --git a/docs/dashboard/dimensions-contexts-families.mdx b/docs/dashboard/dimensions-contexts-families.mdx index 4b9a9051f3..05aa763202 100644 --- a/docs/dashboard/dimensions-contexts-families.mdx +++ b/docs/dashboard/dimensions-contexts-families.mdx @@ -7,14 +7,14 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/dashboard/d # Chart dimensions, contexts, and families -While Netdata's charts require no configuration and are [easy to interact with](/docs/dashboards/interact-charts.mdx), +While Netdata's charts require no configuration and are [easy to interact with](/docs/dashboard/interact-charts.mdx), they have a lot of underlying complexity. To meaningfully organize charts out of the box based on what's happening in your nodes, Netdata uses the concepts of **dimensions**, **contexts**, and **families**. Understanding how these work will help you more easily navigate the dashboard, [write new -alarms](/docs/monitor/configure-alars.md), or play around with the [API](/web/api/README.md). +alarms](/docs/monitor/configure-alarms.md), or play around with the [API](/web/api/README.md). -For a refresher on the anatomy of a chart, see [dashboards and charts](/docs/dashboards/dashboards-charts.mdx). +For a refresher on the anatomy of a chart, see [dashboards and charts](/docs/dashboard/dashboards-charts.mdx). ## Dimension @@ -23,8 +23,7 @@ average (the default), minimum, or maximum. These values can then be given any t utilization is represented as a percentage, disk I/O as `MiB/s`, and available RAM as an absolute value in `MiB` or `GiB`. -Beneath every chart (or on the right-side if you [configure the -dashboard](/docs/dashboards/customize.mdx#change-chart-legend-position)) is a legend of dimensions. When there are +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 @@ -37,7 +36,7 @@ dimensions](https://user-images.githubusercontent.com/1153921/114207816-a5cb7400 The chart shows 13 unique dimensions, such as `httpd` for the CPU utilization for web servers, `kernel` for anything related to the Linux kernel, and so on. In your dashboard, these specific dimensions will almost certainly be different. -Dimensions can be [hidden](/docs/dashboards/interact-charts.mdx#show-and-hide-dimensions) to help you focus your +Dimensions can be [hidden](/docs/dashboard/interact-charts.mdx#show-and-hide-dimensions) to help you focus your attention. ## Context @@ -80,7 +79,7 @@ names: ## What's next? With an understanding of a chart's dimensions, context, and family, you're now ready to dig even deeper into Netdata's -dashboard. We recommend looking into [using the timeframe selector](/docs/dashboards/select-timeframes.mdx). +dashboard. We recommend looking into [using the timeframe selector](/docs/dashboard/select-timeframes.mdx). If you feel comfortable with the [dashboard](/docs/dashboard/how-dashboard-works.mdx) and interacting with charts, we recommend learning about [configuration](/docs/configure/nodes.md). While Netdata doesn't _require_ a complicated setup diff --git a/docs/dashboard/select-timeframes.mdx b/docs/dashboard/select-timeframes.mdx index 6385ace1eb..382a2b6650 100644 --- a/docs/dashboard/select-timeframes.mdx +++ b/docs/dashboard/select-timeframes.mdx @@ -75,5 +75,5 @@ snapshots](/docs/dashboards/import-export-snapshots.mdx) or ### Further reading & related information -- [Interact with charts](/docs/dashboards/interact-charts.mdx) +- [Interact with charts](/docs/dashboard/interact-charts.mdx) - [Database engine reference](/database/engine/README.md) diff --git a/packaging/docker/README.md b/packaging/docker/README.md index 8719d45ea9..ed136cfa90 100644 --- a/packaging/docker/README.md +++ b/packaging/docker/README.md @@ -354,9 +354,8 @@ services: ### Pass command line options to Netdata Since we use an [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint) directive, you can provide -[Netdata daemon command line options](https://learn.netdata.cloud/docs/agent/daemon/#command-line-options) such as the -IP address Netdata will be running on, using the [command -instruction](https://docs.docker.com/engine/reference/builder/#cmd). +[Netdata daemon command line options](/daemon/README.md#command-line-options) such as the IP address Netdata will be +running on, using the [command instruction](https://docs.docker.com/engine/reference/builder/#cmd). ## Install the Agent using Docker Compose with SSL/TLS enabled HTTP Proxy -- cgit v1.2.3