From 46a8075c8ff6da974d1b39f5b3b9eb50385892c1 Mon Sep 17 00:00:00 2001
From: Joel Hans <joel@netdata.cloud>
Date: Thu, 7 Jan 2021 11:44:43 -0700
Subject: [PATCH] Docs housekeeping for SEO and syntax, part 1 (#10388)
* First pass to get the script working right
* Finish adding analytics tags
---
BREAKING_CHANGES.md | 9 +-
BUILD.md | 3 +-
CODE_OF_CONDUCT.md | 2 -
REDISTRIBUTED.md | 2 -
SECURITY.md | 3 +-
backends/README.md | 2 -
backends/TIMESCALE.md | 2 -
backends/WALKTHROUGH.md | 2 -
backends/aws_kinesis/README.md | 2 -
backends/mongodb/README.md | 2 -
backends/opentsdb/README.md | 4 +-
backends/prometheus/README.md | 2 -
backends/prometheus/remote_write/README.md | 2 -
build_external/README.md | 3 +-
claim/README.md | 2 +-
cli/README.md | 9 +-
collectors/QUICKSTART.md | 4 +-
collectors/README.md | 2 -
collectors/REFERENCE.md | 4 +-
collectors/cgroups.plugin/README.md | 2 -
collectors/checks.plugin/README.md | 2 -
collectors/cups.plugin/README.md | 4 +-
collectors/diskspace.plugin/README.md | 3 +-
collectors/fping.plugin/README.md | 2 -
collectors/freebsd.plugin/README.md | 2 -
collectors/freeipmi.plugin/README.md | 2 -
collectors/idlejitter.plugin/README.md | 2 -
collectors/ioping.plugin/README.md | 2 -
collectors/macos.plugin/README.md | 2 -
collectors/nfacct.plugin/README.md | 2 -
collectors/perf.plugin/README.md | 2 -
collectors/plugins.d/README.md | 2 -
collectors/proc.plugin/README.md | 2 -
collectors/python.d.plugin/alarms/README.md | 2 +
collectors/python.d.plugin/am2320/README.md | 2 +
.../python.d.plugin/anomalies/README.md | 2 +
collectors/python.d.plugin/gearman/README.md | 2 +-
collectors/python.d.plugin/hpssa/README.md | 2 +
collectors/python.d.plugin/riakkv/README.md | 2 +
collectors/slabinfo.plugin/README.md | 2 -
collectors/statsd.plugin/README.md | 21 +-
collectors/tc.plugin/README.md | 2 -
collectors/xenstat.plugin/README.md | 2 -
contrib/README.md | 2 -
contrib/sles11/README.md | 2 -
daemon/README.md | 2 -
daemon/config/README.md | 4 +-
database/README.md | 3 +-
diagrams/data_structures/README.md | 2 -
docs/Add-more-charts-to-netdata.md | 4 +-
docs/Demo-Sites.md | 2 -
docs/Donations-netdata-has-received.md | 2 -
docs/README.md | 4 +-
docs/Running-behind-apache.md | 2 -
docs/Running-behind-caddy.md | 2 -
docs/Running-behind-haproxy.md | 2 -
docs/Running-behind-lighttpd.md | 2 -
docs/Running-behind-nginx.md | 2 -
docs/a-github-star-is-important.md | 2 -
docs/agent-cloud.md | 6 +-
docs/anonymous-statistics.md | 5 +-
docs/configuration-guide.md | 211 ++++++++++++++++++
docs/getting-started.md | 2 -
docs/guides/deploy/ansible.md | 2 +-
.../export/export-netdata-metrics-graphite.md | 2 +-
docs/guides/monitor/dimension-templates.md | 2 -
.../monitor/stop-notifications-alarms.md | 2 -
docs/netdata-for-IoT.md | 2 -
docs/netdata-security.md | 2 -
docs/privacy-policy.md | 2 -
docs/terms-of-use.md | 2 -
docs/why-netdata/1s-granularity.md | 2 -
docs/why-netdata/README.md | 2 -
docs/why-netdata/immediate-results.md | 2 -
docs/why-netdata/meaningful-presentation.md | 2 -
docs/why-netdata/unlimited-metrics.md | 2 -
health/notifications/alerta/README.md | 3 +-
health/notifications/awssns/README.md | 3 +-
health/notifications/custom/README.md | 2 -
health/notifications/discord/README.md | 2 -
health/notifications/dynatrace/README.md | 2 +
health/notifications/email/README.md | 2 -
health/notifications/irc/README.md | 2 -
health/notifications/kavenegar/README.md | 2 -
health/notifications/messagebird/README.md | 2 -
health/notifications/pagerduty/README.md | 2 -
health/notifications/prowl/README.md | 2 +
health/notifications/pushbullet/README.md | 2 -
health/notifications/pushover/README.md | 2 -
health/notifications/rocketchat/README.md | 2 -
health/notifications/slack/README.md | 2 -
health/notifications/smstools3/README.md | 2 -
health/notifications/syslog/README.md | 2 -
health/notifications/telegram/README.md | 2 -
health/notifications/twilio/README.md | 2 -
health/notifications/web/README.md | 2 -
libnetdata/README.md | 2 -
libnetdata/adaptive_resortable_list/README.md | 2 -
libnetdata/avl/README.md | 2 -
libnetdata/buffer/README.md | 2 -
libnetdata/circular_buffer/README.md | 3 +-
libnetdata/config/README.md | 2 -
libnetdata/json/README.md | 2 -
libnetdata/procfile/README.md | 2 -
libnetdata/storage_number/README.md | 2 -
packaging/DISTRIBUTIONS.md | 2 -
packaging/installer/README.md | 2 +
packaging/installer/UNINSTALL.md | 1 +
packaging/installer/methods/alpine.md | 4 +-
.../installer/methods/cloud-providers.md | 7 +-
packaging/installer/methods/freebsd.md | 2 +
packaging/installer/methods/freenas.md | 4 +-
packaging/installer/methods/kickstart-64.md | 5 +-
packaging/installer/methods/kickstart.md | 5 +-
packaging/installer/methods/macos.md | 4 +-
packaging/installer/methods/manual.md | 5 +-
packaging/installer/methods/offline.md | 21 +-
packaging/installer/methods/packages.md | 8 +-
packaging/installer/methods/pfsense.md | 2 +
packaging/installer/methods/source.md | 4 +-
packaging/installer/methods/synology.md | 5 +-
packaging/maintainers/README.md | 2 -
packaging/makeself/README.md | 3 +-
parser/README.md | 4 +-
registry/README.md | 3 +-
tests/README.md | 2 -
tests/health_mgmtapi/README.md | 2 -
web/api/badges/README.md | 2 -
web/api/exporters/README.md | 2 -
web/api/exporters/prometheus/README.md | 2 -
web/api/exporters/shell/README.md | 2 -
web/api/formatters/README.md | 2 -
web/api/formatters/csv/README.md | 2 -
web/api/formatters/json/README.md | 2 -
web/api/formatters/ssv/README.md | 2 -
web/api/formatters/value/README.md | 2 -
web/api/health/README.md | 2 -
web/api/queries/README.md | 2 -
web/api/queries/average/README.md | 2 -
web/api/queries/des/README.md | 2 -
web/api/queries/incremental_sum/README.md | 2 -
web/api/queries/max/README.md | 2 -
web/api/queries/median/README.md | 3 +-
web/api/queries/min/README.md | 2 -
web/api/queries/ses/README.md | 2 -
web/api/queries/stddev/README.md | 2 -
web/api/queries/sum/README.md | 2 -
web/gui/confluence/README.md | 2 -
web/gui/custom/README.md | 3 +-
web/server/README.md | 19 +-
web/server/static/README.md | 4 +-
151 files changed, 344 insertions(+), 303 deletions(-)
create mode 100644 docs/configuration-guide.md
diff --git a/BREAKING_CHANGES.md b/BREAKING_CHANGES.md
index 3d432888a7..20d055621a 100644
--- a/BREAKING_CHANGES.md
+++ b/BREAKING_CHANGES.md
@@ -1,10 +1,11 @@
<!--
----
-title: "Breaking Changes"
+title: "Breaking changes"
+description: "On occasion, the Netdata team must make significant changes to the open-source Netdata Agent. We publish those breaking changes here for reference."
custom_edit_url: https://github.com/netdata/netdata/edit/master/BREAKING_CHANGES.md
----
-->
-# Breaking Changes
+# Breaking changes
- remove deprecated bash modules (`apache`, `cpu_apps`, `cpufreq`, `exim`, `hddtemp`, `load_average`, `mem_apps`, `mysql`, `nginx`, `phpfpm`, `postfix`, `squid`, `tomcat`) [[#7962](https://github.com/netdata/netdata/pull/7962)]
+
+[](<>)
diff --git a/BUILD.md b/BUILD.md
index 4791bae37a..deb30b37f4 100644
--- a/BUILD.md
+++ b/BUILD.md
@@ -1,8 +1,6 @@
<!--
----
title: "The build system"
custom_edit_url: https://github.com/netdata/netdata/edit/master/BUILD.md
----
-->
# The build system
@@ -364,3 +362,4 @@ Some smaller miscellaeneous suggestions:
* [header checks in CMake](https://stackoverflow.com/questions/647892/how-to-check-header-files-and-library-functions-in-cmake-like-it-is-done-in-auto)
* [how to write platform checks](https://gitlab.kitware.com/cmake/community/wikis/doc/tutorials/How-To-Write-Platform-Checks)
+[](<>)
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
index df053b7bf8..12e959d96d 100644
--- a/CODE_OF_CONDUCT.md
+++ b/CODE_OF_CONDUCT.md
@@ -1,8 +1,6 @@
<!--
----
title: "Netdata Community Code of Conduct"
custom_edit_url: https://github.com/netdata/netdata/edit/master/CODE_OF_CONDUCT.md
----
-->
# Netdata Community Code of Conduct
diff --git a/REDISTRIBUTED.md b/REDISTRIBUTED.md
index 5a3c328709..fb256b5fce 100644
--- a/REDISTRIBUTED.md
+++ b/REDISTRIBUTED.md
@@ -1,8 +1,6 @@
<!--
----
title: "Redistributed software"
custom_edit_url: https://github.com/netdata/netdata/edit/master/REDISTRIBUTED.md
----
-->
# Redistributed software
diff --git a/SECURITY.md b/SECURITY.md
index b44e4e689b..e823e227aa 100644
--- a/SECURITY.md
+++ b/SECURITY.md
@@ -1,8 +1,7 @@
<!--
----
title: "Security Policy"
+description: "The Netdata team maintains and adheres to a formal process any time a member of the community reports a security vulnerability."
custom_edit_url: https://github.com/netdata/netdata/edit/master/SECURITY.md
----
-->
# Security Policy
diff --git a/backends/README.md b/backends/README.md
index ef0719b86b..8d53fd664e 100644
--- a/backends/README.md
+++ b/backends/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "Metrics long term archiving"
custom_edit_url: https://github.com/netdata/netdata/edit/master/backends/README.md
----
-->
# Metrics long term archiving
diff --git a/backends/TIMESCALE.md b/backends/TIMESCALE.md
index dad851fc29..854c4112e8 100644
--- a/backends/TIMESCALE.md
+++ b/backends/TIMESCALE.md
@@ -1,8 +1,6 @@
<!--
----
title: "Writing metrics to TimescaleDB"
custom_edit_url: https://github.com/netdata/netdata/edit/master/backends/TIMESCALE.md
----
-->
# Writing metrics to TimescaleDB
diff --git a/backends/WALKTHROUGH.md b/backends/WALKTHROUGH.md
index 612270cac1..76dd62f834 100644
--- a/backends/WALKTHROUGH.md
+++ b/backends/WALKTHROUGH.md
@@ -1,8 +1,6 @@
<!--
----
title: "Netdata, Prometheus, Grafana stack"
custom_edit_url: https://github.com/netdata/netdata/edit/master/backends/WALKTHROUGH.md
----
-->
# Netdata, Prometheus, Grafana stack
diff --git a/backends/aws_kinesis/README.md b/backends/aws_kinesis/README.md
index 10efe528c3..a2b682517e 100644
--- a/backends/aws_kinesis/README.md
+++ b/backends/aws_kinesis/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "Using Netdata with AWS Kinesis Data Streams"
custom_edit_url: https://github.com/netdata/netdata/edit/master/backends/aws_kinesis/README.md
----
-->
# Using Netdata with AWS Kinesis Data Streams
diff --git a/backends/mongodb/README.md b/backends/mongodb/README.md
index cba8109721..7c7996e1be 100644
--- a/backends/mongodb/README.md
+++ b/backends/mongodb/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "MongoDB backend"
custom_edit_url: https://github.com/netdata/netdata/edit/master/backends/mongodb/README.md
----
-->
# MongoDB backend
diff --git a/backends/opentsdb/README.md b/backends/opentsdb/README.md
index 20abce88c0..b9d0b9873b 100644
--- a/backends/opentsdb/README.md
+++ b/backends/opentsdb/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "OpenTSDB with HTTP"
custom_edit_url: https://github.com/netdata/netdata/edit/master/backends/opentsdb/README.md
----
-->
# OpenTSDB with HTTP
@@ -36,3 +34,5 @@ After your proxy is configured, make the following changes to `netdata.conf`:
In this example, we used the port `8082` for our reverse proxy. If your reverse proxy listens on a different port,
change the `destination = localhost:8082` line accordingly.
+
+[]()
diff --git a/backends/prometheus/README.md b/backends/prometheus/README.md
index 3b4719b970..10275fa205 100644
--- a/backends/prometheus/README.md
+++ b/backends/prometheus/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "Using Netdata with Prometheus"
custom_edit_url: https://github.com/netdata/netdata/edit/master/backends/prometheus/README.md
----
-->
# Using Netdata with Prometheus
diff --git a/backends/prometheus/remote_write/README.md b/backends/prometheus/remote_write/README.md
index c9ae2b1297..b83575e100 100644
--- a/backends/prometheus/remote_write/README.md
+++ b/backends/prometheus/remote_write/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "Prometheus remote write backend"
custom_edit_url: https://github.com/netdata/netdata/edit/master/backends/prometheus/remote_write/README.md
----
-->
# Prometheus remote write backend
diff --git a/build_external/README.md b/build_external/README.md
index 8305836b02..f52f55734a 100644
--- a/build_external/README.md
+++ b/build_external/README.md
@@ -1,9 +1,7 @@
<!--
----
title: "External build-system"
date: 2020-03-31
custom_edit_url: https://github.com/netdata/netdata/edit/master/build_external/README.md
----
-->
# External build-system
@@ -127,3 +125,4 @@ Notes:
* There is not yet a good way to configure the target agent container from the docker-compose command line.
* Several other containers should be in this compose (a paho client, tshark etc).
+[]()
diff --git a/claim/README.md b/claim/README.md
index 17fe255815..a2e5116c13 100644
--- a/claim/README.md
+++ b/claim/README.md
@@ -1,6 +1,6 @@
<!--
title: "Agent claiming"
-description: "Agent claiming allows a Netdata Agent, running on a distributed node, to securely connect to Netdata Cloud. A Space's administrator creates a claiming token, which is used to add an Agent to their Space via the Agent-Cloud link."
+description: "Agent claiming allows a Netdata Agent, running on a distributed node, to securely connect to Netdata Cloud via the encrypted Agent-Cloud link (ACLK)."
custom_edit_url: https://github.com/netdata/netdata/edit/master/claim/README.md
-->
diff --git a/cli/README.md b/cli/README.md
index 8cb33975bf..93812372ab 100644
--- a/cli/README.md
+++ b/cli/README.md
@@ -1,13 +1,12 @@
<!--
----
-title: "Netdata cli"
+title: "Netdata CLI"
+description: "The Netdata Agent includes a command-line experience for reloading health configuration, reopening log files, halting the daemon, and more."
custom_edit_url: https://github.com/netdata/netdata/edit/master/cli/README.md
----
-->
-# Netdata cli
+# Netdata CLI
-You can see the commands netdatacli supports by executing it with `netdatacli` and entering `help` in
+You can see the commands `netdatacli` supports by executing it with `netdatacli` and entering `help` in
standard input. All commands are given as standard input to `netdatacli`.
The commands that a running netdata agent can execute are the following:
diff --git a/collectors/QUICKSTART.md b/collectors/QUICKSTART.md
index e0f1ccecd7..a691ffc4c3 100644
--- a/collectors/QUICKSTART.md
+++ b/collectors/QUICKSTART.md
@@ -1,8 +1,6 @@
<!--
----
title: "Collectors quickstart"
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/QUICKSTART.md
----
-->
# Collectors quickstart
@@ -123,3 +121,5 @@ popular collectors.
Finally, learn more advanced collector features, such as disabling plugins or developing a custom collector, in our
[internal plugin API](/collectors/REFERENCE.md#internal-plugins-api) or our [external plugin
docs](/collectors/plugins.d/README.md).
+
+[]()
diff --git a/collectors/README.md b/collectors/README.md
index 5fed208c9c..ef1f9610c1 100644
--- a/collectors/README.md
+++ b/collectors/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "Collecting metrics"
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/README.md
----
-->
# Collecting metrics
diff --git a/collectors/REFERENCE.md b/collectors/REFERENCE.md
index a49c838859..08a405dc7b 100644
--- a/collectors/REFERENCE.md
+++ b/collectors/REFERENCE.md
@@ -1,8 +1,6 @@
<!--
----
title: "Collectors configuration reference"
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/REFERENCE.md
----
-->
# Collectors configuration reference
@@ -184,3 +182,5 @@ through this, is to examine what other similar plugins do.
## Write a custom collector
You can add custom collectors by following the [external plugins documentation](../collectors/plugins.d/).
+
+[]()
diff --git a/collectors/cgroups.plugin/README.md b/collectors/cgroups.plugin/README.md
index 853c0f5946..9b26deb2ce 100644
--- a/collectors/cgroups.plugin/README.md
+++ b/collectors/cgroups.plugin/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "cgroups.plugin"
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/cgroups.plugin/README.md
----
-->
# cgroups.plugin
diff --git a/collectors/checks.plugin/README.md b/collectors/checks.plugin/README.md
index 57de81e1c1..5f1a6b912b 100644
--- a/collectors/checks.plugin/README.md
+++ b/collectors/checks.plugin/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "checks.plugin"
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/checks.plugin/README.md
----
-->
# checks.plugin
diff --git a/collectors/cups.plugin/README.md b/collectors/cups.plugin/README.md
index 1d52f09e68..373602dca1 100644
--- a/collectors/cups.plugin/README.md
+++ b/collectors/cups.plugin/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "cups.plugin"
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/cups.plugin/README.md
----
-->
# cups.plugin
@@ -60,3 +58,5 @@ For each destination the plugin provides these charts:
- processing
At the moment only job status pending, processing, and held are reported because we do not have a method to collect stopped, canceled, aborted and completed jobs which scales.
+
+[]()
diff --git a/collectors/diskspace.plugin/README.md b/collectors/diskspace.plugin/README.md
index 8f814018ac..a8b41c861d 100644
--- a/collectors/diskspace.plugin/README.md
+++ b/collectors/diskspace.plugin/README.md
@@ -1,8 +1,7 @@
<!--
----
title: "diskspace.plugin"
+description: "Monitor the disk usage space of mounted disks in real-time with the Netdata Agent, plus preconfigured alarms for disks at risk of filling up."
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/diskspace.plugin/README.md
----
-->
# diskspace.plugin
diff --git a/collectors/fping.plugin/README.md b/collectors/fping.plugin/README.md
index ad12faaca1..4aca2a9de3 100644
--- a/collectors/fping.plugin/README.md
+++ b/collectors/fping.plugin/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "fping.plugin"
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/fping.plugin/README.md
----
-->
# fping.plugin
diff --git a/collectors/freebsd.plugin/README.md b/collectors/freebsd.plugin/README.md
index 47090b29ed..1b519a6594 100644
--- a/collectors/freebsd.plugin/README.md
+++ b/collectors/freebsd.plugin/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "freebsd.plugin"
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/freebsd.plugin/README.md
----
-->
# freebsd.plugin
diff --git a/collectors/freeipmi.plugin/README.md b/collectors/freeipmi.plugin/README.md
index 7ea57ed8ac..64328fc9e7 100644
--- a/collectors/freeipmi.plugin/README.md
+++ b/collectors/freeipmi.plugin/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "freeipmi.plugin"
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/freeipmi.plugin/README.md
----
-->
# freeipmi.plugin
diff --git a/collectors/idlejitter.plugin/README.md b/collectors/idlejitter.plugin/README.md
index 139b9b1690..3703e2ee25 100644
--- a/collectors/idlejitter.plugin/README.md
+++ b/collectors/idlejitter.plugin/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "idlejitter.plugin"
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/idlejitter.plugin/README.md
----
-->
# idlejitter.plugin
diff --git a/collectors/ioping.plugin/README.md b/collectors/ioping.plugin/README.md
index a48511c005..08b0ce8b15 100644
--- a/collectors/ioping.plugin/README.md
+++ b/collectors/ioping.plugin/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "ioping.plugin"
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/ioping.plugin/README.md
----
-->
# ioping.plugin
diff --git a/collectors/macos.plugin/README.md b/collectors/macos.plugin/README.md
index 7e61efcd04..800eb0e85e 100644
--- a/collectors/macos.plugin/README.md
+++ b/collectors/macos.plugin/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "macos.plugin"
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/macos.plugin/README.md
----
-->
# macos.plugin
diff --git a/collectors/nfacct.plugin/README.md b/collectors/nfacct.plugin/README.md
index ac5092f2ae..1bd8a46e8f 100644
--- a/collectors/nfacct.plugin/README.md
+++ b/collectors/nfacct.plugin/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "nfacct.plugin"
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/nfacct.plugin/README.md
----
-->
# nfacct.plugin
diff --git a/collectors/perf.plugin/README.md b/collectors/perf.plugin/README.md
index 2131e71671..d4bb41cb60 100644
--- a/collectors/perf.plugin/README.md
+++ b/collectors/perf.plugin/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "perf.plugin"
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/perf.plugin/README.md
----
-->
# perf.plugin
diff --git a/collectors/plugins.d/README.md b/collectors/plugins.d/README.md
index 3ce463e228..913ad9177c 100644
--- a/collectors/plugins.d/README.md
+++ b/collectors/plugins.d/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "External plugins overview"
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/plugins.d/README.md
----
-->
# External plugins overview
diff --git a/collectors/proc.plugin/README.md b/collectors/proc.plugin/README.md
index 6a8dc71142..085afb4fb6 100644
--- a/collectors/proc.plugin/README.md
+++ b/collectors/proc.plugin/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "proc.plugin"
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/proc.plugin/README.md
----
-->
# proc.plugin
diff --git a/collectors/python.d.plugin/alarms/README.md b/collectors/python.d.plugin/alarms/README.md
index ea90529529..ea96061cc7 100644
--- a/collectors/python.d.plugin/alarms/README.md
+++ b/collectors/python.d.plugin/alarms/README.md
@@ -54,3 +54,5 @@ local:
```
It will default to pulling all alarms at each time step from the Netdata rest api at `http://127.0.0.1:19999/api/v1/alarms?all`
+
+[]()
diff --git a/collectors/python.d.plugin/am2320/README.md b/collectors/python.d.plugin/am2320/README.md
index cfc8a69501..c17b33dfa1 100644
--- a/collectors/python.d.plugin/am2320/README.md
+++ b/collectors/python.d.plugin/am2320/README.md
@@ -50,3 +50,5 @@ Software install:
- save the file.
- restart the netdata service.
- check the dashboard.
+
+[]()
diff --git a/collectors/python.d.plugin/anomalies/README.md b/collectors/python.d.plugin/anomalies/README.md
index 95245a450e..487a11a095 100644
--- a/collectors/python.d.plugin/anomalies/README.md
+++ b/collectors/python.d.plugin/anomalies/README.md
@@ -225,3 +225,5 @@ If you would like to go deeper on what exactly the anomalies collector is doing
- [Mendeley public group](https://www.mendeley.com/community/interesting-anomaly-detection-papers/) with some interesting anomaly detection papers we have been reading.
- Good [blog post](https://www.anodot.com/blog/what-is-anomaly-detection/) from Anodot on time series anomaly detection. Anodot also have some great whitepapers in this space too that some may find useful.
- Novelty and outlier detection in the [scikit-learn documentation](https://scikit-learn.org/stable/modules/outlier_detection.html).
+
+[]()
diff --git a/collectors/python.d.plugin/gearman/README.md b/collectors/python.d.plugin/gearman/README.md
index 7e96f8fc62..b9fc914bf7 100644
--- a/collectors/python.d.plugin/gearman/README.md
+++ b/collectors/python.d.plugin/gearman/README.md
@@ -48,4 +48,4 @@ localhost:
When no configuration file is found, module tries to connect to TCP/IP socket: `localhost:4730`.
----
+[]()
diff --git a/collectors/python.d.plugin/hpssa/README.md b/collectors/python.d.plugin/hpssa/README.md
index b1157bf9fa..426f19c536 100644
--- a/collectors/python.d.plugin/hpssa/README.md
+++ b/collectors/python.d.plugin/hpssa/README.md
@@ -51,3 +51,5 @@ If `ssacli` cannot be found in the `PATH`, configure it in `hpssa.conf`.
```yaml
ssacli_path: /usr/sbin/ssacli
```
+
+[]()
diff --git a/collectors/python.d.plugin/riakkv/README.md b/collectors/python.d.plugin/riakkv/README.md
index fe62c67189..d0ea9a1379 100644
--- a/collectors/python.d.plugin/riakkv/README.md
+++ b/collectors/python.d.plugin/riakkv/README.md
@@ -124,3 +124,5 @@ With no explicit configuration given, the module will attempt to connect to
The default update frequency for the plugin is set to 2 seconds as Riak
internally updates the metrics every second. If we were to update the metrics
every second, the resulting graph would contain odd jitter.
+
+[]()
diff --git a/collectors/slabinfo.plugin/README.md b/collectors/slabinfo.plugin/README.md
index 3ba701838d..21d83c999b 100644
--- a/collectors/slabinfo.plugin/README.md
+++ b/collectors/slabinfo.plugin/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "slabinfo.plugin"
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/slabinfo.plugin/README.md
----
-->
# slabinfo.plugin
diff --git a/collectors/statsd.plugin/README.md b/collectors/statsd.plugin/README.md
index 681d48294f..d5bc0d1ad5 100644
--- a/collectors/statsd.plugin/README.md
+++ b/collectors/statsd.plugin/README.md
@@ -1,8 +1,7 @@
<!--
----
title: "statsd.plugin"
+description: "The Netdata Agent is a fully-featured statsd server that collects metrics from any custom application and visualizes them in real-time."
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/statsd.plugin/README.md
----
-->
# statsd.plugin
@@ -219,7 +218,8 @@ The same chart with the `sum` unselected:
### synthetic statsd charts
-Using synthetic charts, you can create dedicated sections on the dashboard to render the charts. You can control everything: the main menu, the submenus, the charts, the dimensions on each chart, etc.
+Use synthetic charts to create dedicated sections on the dashboard to render the charts, with control over the main
+menu, the submenus, the charts, the dimensions on each chart, and more.
Synthetic charts are organized in
@@ -229,7 +229,7 @@ Synthetic charts are organized in
For each application you need to create a `.conf` file in `/etc/netdata/statsd.d`.
-So, to create the statsd application `myapp`, you can create the file `/etc/netdata/statsd.d/myapp.conf`, with this content:
+So, to create the statsd application `myapp`, create the file `/etc/netdata/statsd.d/myapp.conf`, with this content:
```
[app]
@@ -271,9 +271,9 @@ Using the above configuration `myapp` should get its own section on the dashboar
`[dictionary]` defines name-value associations. These are used to renaming metrics, when added to synthetic charts. Metric names are also defined at each `dimension` line. However, using the dictionary dimension names can be declared globally, for each app and is the only way to rename dimensions when using patterns. Of course the dictionary can be empty or missing.
-Then, you can add any number of charts. Each chart should start with `[id]`. The chart will be called `app_name.id`. `family` controls the submenu on the dashboard. `context` controls the alarm templates. `priority` controls the ordering of the charts on the dashboard. The rest of the settings are informational.
+Then, add any number of charts. Each chart should start with `[id]`. The chart will be called `app_name.id`. `family` controls the submenu on the dashboard. `context` controls the alarm templates. `priority` controls the ordering of the charts on the dashboard. The rest of the settings are informational.
-You can add any number of metrics to a chart, using `dimension` lines. These lines accept 5 space separated parameters:
+Add any number of metrics to a chart, using `dimension` lines. These lines accept 5 space separated parameters:
1. the metric name, as it is collected (it has to be matched by the `metrics =` pattern of the app)
2. the dimension name, as it should be shown on the chart
@@ -351,12 +351,12 @@ Netdata uses this dictionary as follows:
3. If any of the above succeeds, Netdata uses the `value` of the dictionary, to set the name of the dimension. The dimensions will have as ID the original statsd metric name, and as name, the dictionary value.
-So, you can use the dictionary in 2 ways:
+Use the dictionary in 2 ways:
1. set `dimension = myapp.metric1 ''` and have at the dictionary `myapp.metric1 = metric1 name`
2. set `dimension = myapp.metric1 'm1'` and have at the dictionary `m1 = metric1 name`
-In both cases, the dimension will be added with ID `myapp.metric1` and will be named `metric1 name`. So, in alarms you can use either of the 2 as `${myapp.metric1}` or `${metric1 name}`.
+In both cases, the dimension will be added with ID `myapp.metric1` and will be named `metric1 name`. So, in alarms use either of the 2 as `${myapp.metric1}` or `${metric1 name}`.
> keep in mind that if you add multiple times the same statsd metric to a chart, Netdata will append `TYPE` to the dimension ID, so `myapp.metric1` will be added as `myapp.metric1_last` or `myapp.metric1_events`, etc. If you add multiple times the same metric with the same `TYPE` to a chart, Netdata will also append an incremental counter to the dimension ID, i.e. `myapp.metric1_last1`, `myapp.metric1_last2`, etc.
@@ -389,7 +389,7 @@ To add all response codes of `myapp.api.get` to a chart use this:
dimension = pattern 'myapp.api.get.* '' last 1 1
```
-The above will add dimension named `200`, `400` and `500` (yes, Netdata extracts the wildcarded part of the metric name - so the dimensions will be named with whatever the `*` matched). You can rename the dimensions with this:
+The above will add dimension named `200`, `400` and `500` (yes, Netdata extracts the wildcarded part of the metric name - so the dimensions will be named with whatever the `*` matched). Rename the dimensions with this:
```
[dictionary]
@@ -451,7 +451,8 @@ Using the above, the dimensions will be added as `GET`, `ADD` and `DELETE`.
## sending statsd metrics from shell scripts
-You can send/update statsd metrics from shell scripts. You can use this feature, to visualize in Netdata automated jobs you run on your servers.
+Send/update statsd metrics from shell scripts to visualize automated jobs you run on your servers using the Netdata
+Agent.
The command you need to run is:
diff --git a/collectors/tc.plugin/README.md b/collectors/tc.plugin/README.md
index 3ef47c11a8..70e31c236b 100644
--- a/collectors/tc.plugin/README.md
+++ b/collectors/tc.plugin/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "tc.plugin"
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/tc.plugin/README.md
----
-->
# tc.plugin
diff --git a/collectors/xenstat.plugin/README.md b/collectors/xenstat.plugin/README.md
index 7d79d41faf..61be271d99 100644
--- a/collectors/xenstat.plugin/README.md
+++ b/collectors/xenstat.plugin/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "xenstat.plugin"
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/xenstat.plugin/README.md
----
-->
# xenstat.plugin
diff --git a/contrib/README.md b/contrib/README.md
index a9e89ce11a..e253efa993 100644
--- a/contrib/README.md
+++ b/contrib/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "Netdata contrib"
custom_edit_url: https://github.com/netdata/netdata/edit/master/contrib/README.md
----
-->
# Netdata contrib
diff --git a/contrib/sles11/README.md b/contrib/sles11/README.md
index 3bb995f38e..4cdf7e9f91 100644
--- a/contrib/sles11/README.md
+++ b/contrib/sles11/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "Spec to build Netdata RPM for sles 11"
custom_edit_url: https://github.com/netdata/netdata/edit/master/contrib/sles11/README.md
----
-->
# Spec to build Netdata RPM for sles 11
diff --git a/daemon/README.md b/daemon/README.md
index 29fc6a6125..9aa483b711 100644
--- a/daemon/README.md
+++ b/daemon/README.md
@@ -1,9 +1,7 @@
<!--
----
title: "Netdata daemon"
date: 2020-04-29
custom_edit_url: https://github.com/netdata/netdata/edit/master/daemon/README.md
----
-->
# Netdata daemon
diff --git a/daemon/config/README.md b/daemon/config/README.md
index 211039396b..71c0c0e841 100644
--- a/daemon/config/README.md
+++ b/daemon/config/README.md
@@ -1,9 +1,7 @@
<!--
----
title: "Daemon configuration"
-date: 2020-03-31
+description: "The Netdata Agent's daemon is installed preconfigured to collect thousands of metrics every second, but is highly configurable for real-world workloads."
custom_edit_url: https://github.com/netdata/netdata/edit/master/daemon/config/README.md
----
-->
# Daemon configuration
diff --git a/database/README.md b/database/README.md
index 1dca14c262..9fef705803 100644
--- a/database/README.md
+++ b/database/README.md
@@ -1,8 +1,7 @@
<!--
----
title: "Database"
+description: "The Netdata Agent leverages multiple, user-configurable time-series databases that use RAM and/or disk to store metrics on any type of node."
custom_edit_url: https://github.com/netdata/netdata/edit/master/database/README.md
----
-->
# Database
diff --git a/diagrams/data_structures/README.md b/diagrams/data_structures/README.md
index 4e9d14f4ae..27705c5489 100644
--- a/diagrams/data_structures/README.md
+++ b/diagrams/data_structures/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "Data structures"
custom_edit_url: https://github.com/netdata/netdata/edit/master/diagrams/data_structures/README.md
----
-->
# Data structures
diff --git a/docs/Add-more-charts-to-netdata.md b/docs/Add-more-charts-to-netdata.md
index d607111b3f..a16f2e9dbc 100644
--- a/docs/Add-more-charts-to-netdata.md
+++ b/docs/Add-more-charts-to-netdata.md
@@ -1,8 +1,6 @@
<!--
----
title: "Add more charts to Netdata"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Add-more-charts-to-netdata.md
----
-->
# Add more charts to Netdata
@@ -14,3 +12,5 @@ guide](/collectors/QUICKSTART.md) for more information.
See the [list of supported collectors](/collectors/COLLECTORS.md) to see all the sources Netdata can collect metrics
from.
+
+[]()
diff --git a/docs/Demo-Sites.md b/docs/Demo-Sites.md
index 2fce066b37..8af1282ba4 100644
--- a/docs/Demo-Sites.md
+++ b/docs/Demo-Sites.md
@@ -1,9 +1,7 @@
<!--
----
title: "Demo sites"
date: 2020-03-26
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Demo-Sites.md
----
-->
# Demo sites
diff --git a/docs/Donations-netdata-has-received.md b/docs/Donations-netdata-has-received.md
index 2c75b87436..df6c040bab 100644
--- a/docs/Donations-netdata-has-received.md
+++ b/docs/Donations-netdata-has-received.md
@@ -1,8 +1,6 @@
<!--
----
title: "Donations"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Donations-netdata-has-received.md
----
-->
# Donations
diff --git a/docs/README.md b/docs/README.md
index c483cb7ad1..47950f3889 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "Read documentation on <https://learn.netdata.cloud>"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/README.md
----
-->
# Read documentation on <https://learn.netdata.cloud>
@@ -15,3 +13,5 @@ uses a few extra Markdown features that GitHub doesn't support natively. Other t
perfect.
Now get out there and build an exceptional infrastructure.
+
+[](<>)
diff --git a/docs/Running-behind-apache.md b/docs/Running-behind-apache.md
index 930c220fda..8a547e7b4f 100644
--- a/docs/Running-behind-apache.md
+++ b/docs/Running-behind-apache.md
@@ -1,8 +1,6 @@
<!--
----
title: "Netdata via apache's mod_proxy"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Running-behind-apache.md
----
-->
# Netdata via apache's mod_proxy
diff --git a/docs/Running-behind-caddy.md b/docs/Running-behind-caddy.md
index 01934b5749..c1d57504ad 100644
--- a/docs/Running-behind-caddy.md
+++ b/docs/Running-behind-caddy.md
@@ -1,8 +1,6 @@
<!--
----
title: "Netdata via Caddy"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Running-behind-caddy.md
----
-->
# Netdata via Caddy
diff --git a/docs/Running-behind-haproxy.md b/docs/Running-behind-haproxy.md
index 212779b4b2..d4b09f85c7 100644
--- a/docs/Running-behind-haproxy.md
+++ b/docs/Running-behind-haproxy.md
@@ -1,8 +1,6 @@
<!--
----
title: "Netdata via HAProxy"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Running-behind-haproxy.md
----
-->
# Netdata via HAProxy
diff --git a/docs/Running-behind-lighttpd.md b/docs/Running-behind-lighttpd.md
index 25c62cff4d..8649158002 100644
--- a/docs/Running-behind-lighttpd.md
+++ b/docs/Running-behind-lighttpd.md
@@ -1,8 +1,6 @@
<!--
----
title: "Netdata via lighttpd v1.4.x"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Running-behind-lighttpd.md
----
-->
# Netdata via lighttpd v1.4.x
diff --git a/docs/Running-behind-nginx.md b/docs/Running-behind-nginx.md
index 35e6c8051a..2f47447da3 100644
--- a/docs/Running-behind-nginx.md
+++ b/docs/Running-behind-nginx.md
@@ -1,8 +1,6 @@
<!--
----
title: "Running Netdata behind Nginx"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Running-behind-nginx.md
----
-->
# Running Netdata behind Nginx
diff --git a/docs/a-github-star-is-important.md b/docs/a-github-star-is-important.md
index 6730dfecfe..d309d3928a 100644
--- a/docs/a-github-star-is-important.md
+++ b/docs/a-github-star-is-important.md
@@ -1,8 +1,6 @@
<!--
----
title: "A GitHub star is important"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/a-github-star-is-important.md
----
-->
# A GitHub star is important
diff --git a/docs/agent-cloud.md b/docs/agent-cloud.md
index 2a03582c2b..061b8472db 100644
--- a/docs/agent-cloud.md
+++ b/docs/agent-cloud.md
@@ -1,9 +1,7 @@
<!--
----
title: "Use the Agent with Netdata Cloud"
date: 2020-05-04
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/agent-cloud.md
----
-->
# Use the Agent with Netdata Cloud
@@ -76,4 +74,6 @@ about how you might want to use or configure Cloud, we recommend the following:
- Follow the 5-minute [get started with Cloud](https://learn.netdata.cloud/docs/cloud/get-started/) guide to finish
onboarding and claim your first nodes.
- Better understand how agents connect securely to the Cloud with [claiming](/claim/README.md) and [Agent-Cloud
- link](/aclk/README.md) documentation.
\ No newline at end of file
+ link](/aclk/README.md) documentation.
+
+[]()
diff --git a/docs/anonymous-statistics.md b/docs/anonymous-statistics.md
index 71c995a519..70c502d063 100644
--- a/docs/anonymous-statistics.md
+++ b/docs/anonymous-statistics.md
@@ -1,8 +1,7 @@
<!--
----
title: "Anonymous statistics"
+description: "The Netdata Agent collects anonymous usage information by default and sends it to Google Analytics for quality assurance and product decisions."
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/anonymous-statistics.md
----
-->
# Anonymous statistics
@@ -106,3 +105,5 @@ Each of these opt-out processes does the following:
- Forces the anonymous statistics script to exit immediately.
- Stops the Google Tag Manager Javascript snippet, which remains on the dashboard, from firing and sending any data to
Google Analytics.
+
+[]()
diff --git a/docs/configuration-guide.md b/docs/configuration-guide.md
new file mode 100644
index 0000000000..06b61d08d1
--- /dev/null
+++ b/docs/configuration-guide.md
@@ -0,0 +1,211 @@
+<!--
+title: "Configuration guide"
+custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/configuration-guide.md
+-->
+
+# Configuration guide
+
+No configuration is required to run Netdata, but you will find plenty of options to tweak, so that you can adapt it to
+your particular needs.
+
+<details markdown="1"><summary>Configuration files are placed in `/etc/netdata`.</summary>
+Depending on your installation method, Netdata will have been installed either directly under `/`, or under `/opt/netdata`. The paths mentioned here and in the documentation in general assume that your installation is under `/`. If it is not, you will find the exact same paths under `/opt/netdata` as well. (i.e. `/etc/netdata` will be `/opt/netdata/etc/netdata`).</details>
+
+Under that directory you will see the following:
+
+- `netdata.conf` is [the main configuration file](/daemon/config/README.md#daemon-configuration)
+- `edit-config` is an sh script that you can use to easily and safely edit the configuration. Just run it to see its
+ usage.
+- Other directories, initially empty, where your custom configurations for alarms and collector plugins/modules will
+ be copied from the stock configuration, if and when you customize them using `edit-config`.
+- `orig` is a symbolic link to the directory `/usr/lib/netdata/conf.d`, which contains the stock configurations for
+ everything not included in `netdata.conf`:
+ - `health_alarm_notify.conf` is where you configure how and to who Netdata will send [alarm
+ notifications](/health/notifications/README.md#netdata-alarm-notifications).
+ - `health.d` is the directory that contains the alarm triggers for [health
+ monitoring](/health/README.md#health-monitoring). It contains one .conf file per collector.
+ - The [modular plugin orchestrators](/collectors/plugins.d/README.md#external-plugins-overview) have:
+ - One config file each, mainly to turn their modules on and off: `python.d.conf` for
+ [python](/collectors/python.d.plugin/README.md#pythondplugin), `node.d.conf` for
+ [nodejs](/collectors/node.d.plugin/README.md#nodedplugin) and `charts.d.conf` for
+ [bash](/collectors/charts.d.plugin/README.md#chartsdplugin) modules.
+ - One directory each, where the module-specific configuration files can be found.
+ - `stream.conf` is where you configure [streaming and
+ replication](/streaming/README.md#streaming-and-replication)
+ - `stats.d` is a directory under which you can add .conf files to add [synthetic
+ charts](/collectors/statsd.plugin/README.md#synthetic-statsd-charts).
+ - Individual collector plugin config files, such as `fping.conf` for the [fping
+ plugin](/collectors/fping.plugin/) and `apps_groups.conf` for the [apps plugin](/collectors/apps.plugin/)
+
+So there are many configuration files to control every aspect of Netdata's behavior. It can be overwhelming at first,
+but you won't have to deal with any of them, unless you have specific things you need to change. The following HOWTO
+will guide you on how to customize your Netdata, based on what you want to do.
+
+## How to
+
+### Persist my configuration
+
+In `http://localhost:19999/netdata.conf`, you will see the following two parameters:
+
+```bash
+ # config directory = /etc/netdata
+ # stock config directory = /usr/lib/netdata/conf.d
+```
+
+To persist your configurations, don't edit the files under the `stock config directory` directly. Use the `sudo [config
+directory]/edit-config` command, or copy the stock config file to its proper place under the `config directory` and edit
+it there.
+
+### Change what I see
+
+#### Increase the long-term metrics retention period
+
+Increase the values for the `page cache size` and `dbengine disk space` settings in the [`[global]`
+section](/daemon/config/README.md#global-section-options) of `netdata.conf`. Read our guide on [increasing
+long-term metrics storage](/docs/guides/longer-metrics-storage.md) and the [memory requirements for the database
+engine](/database/engine/README.md#memory-requirements).
+
+#### Reduce the data collection frequency
+
+Increase `update every` in [netdata.conf \[global\]](/daemon/config/README.md#global-section-options). This is another
+way to increase your metrics retention period, but at a lower resolution than the default 1s.
+
+#### Modify how a chart is displayed
+
+In `netdata.conf` under `# Per chart configuration` you will find several [\[CHART_NAME\]
+sections](/daemon/config/README.md#per-chart-configuration), where you can control all aspects of a specific chart.
+
+#### Disable a collector
+
+Entire plugins can be turned off from the [netdata.conf \[plugins\]](/daemon/config/README.md#plugins-section-options)
+section. To disable specific modules of a plugin orchestrator, you need to edit one of the following:
+
+- `python.d.conf` for [python](/collectors/python.d.plugin/README.md)
+- `node.d.conf` for [nodejs](/collectors/node.d.plugin/README.md)
+- `charts.d.conf` for [bash](/collectors/charts.d.plugin/README.md)
+
+#### Show charts with zero metrics
+
+By default, Netdata will enable monitoring metrics for disks, memory, and network only when they are not zero. If they
+are constantly zero they are ignored. Metrics that will start having values, after Netdata is started, will be detected
+and charts will be automatically added to the dashboard (a refresh of the dashboard is needed for them to appear
+though). Use `yes` instead of `auto` in plugin configuration sections to enable these charts permanently. You can also
+set the `enable zero metrics` option to `yes` in the `[global]` section which enables charts with zero metrics for all
+internal Netdata plugins.
+
+### Modify alarms and notifications
+
+#### Add a new alarm
+
+You can add a new alarm definition either by editing an existing stock alarm config file under `health.d` (e.g.
+`/etc/netdata/edit-config health.d/load.conf`), or by adding a new `.conf` file under `/etc/netdata/health.d`. The
+documentation on how to define an alarm is in [health monitoring](/health/README.md). It is
+suggested to look at some of the stock alarm definitions, so you can ensure you understand how the various options work.
+
+#### Turn off all alarms and notifications
+
+Just set `enabled = no` in the [netdata.conf \[health\]](/daemon/config/README.md#health-section-options) section
+
+#### Modify or disable a specific alarm
+
+The `health.d` directory that contains the alarm triggers for [health monitoring](/health/README.md). It has
+one .conf file per collector. You can easily find the .conf file you will need to modify, by looking for the "source"
+line on the table that appears on the right side of an alarm on the Netdata gui.
+
+For example, if you click on Alarms and go to the tab 'All', the default Netdata installation will show you at the top
+the configured alarm for `10 min cpu usage` (it's the name of the badge). Looking at the table on the right side, you
+will see a row that says: `source 4@/usr/lib/netdata/conf.d/health.d/cpu.conf`. This way, you know that you will need
+to run `/etc/netdata/edit-config health.d/cpu.conf` and look for alarm at line 4 of the conf file.
+
+As stated at the top of the .conf file, **you can disable an alarm notification by setting the 'to' line to: silent**.
+To modify how the alarm gets triggered, we suggest that you go through the guide on [health
+monitoring](/health/README.md#health-monitoring).
+
+#### Receive notifications using my preferred method
+
+You only need to configure `health_alarm_notify.conf`. To learn how to do it, read first [alarm
+notifications](/health/notifications/README.md#netdata-alarm-notifications) and then open the submenu `Supported
+Notifications` under `Alarm notifications` in the documentation to find the specific page on your preferred notification
+method.
+
+### Make security-related customizations
+
+#### Change the Netdata web server access lists
+
+You have several options under the [netdata.conf \[web\]](/web/server/README.md#access-lists) section.
+
+#### Stop sending info to registry.my-netdata.io
+
+You will need to configure the `[registry]` section in `netdata.conf`. First read the [registry
+documentation](/registry/). In it, are instructions on how to [run your own
+registry](/registry/README.md#run-your-own-registry).
+
+#### Change the IP address/port Netdata listens to
+
+The settings are under the `[web]` section. Look at the [web server
+documentation](/web/server/README.md#binding-netdata-to-multiple-ports) for more info.
+
+### System resource usage
+
+#### Reduce the resources Netdata uses
+
+The [Netdata performance guide](/docs/guides/configure/performance.md) outlines many ways to reduce the Netdata
+CPU/disk/RAM utilization to levels suitable even for the weakest [IoT devices](/docs/netdata-for-IoT.md).
+
+#### Change when Netdata saves metrics to disk
+
+[netdata.conf \[global\]](/daemon/config/README.md#global-section-options): `memory mode`
+
+#### Prevent Netdata from getting immediately killed when my server runs out of memory
+
+You can change the Netdata [OOM score](/daemon/README.md#oom-score) in `[global]`.
+
+### Other
+
+#### Move Netdata directories
+
+The various directory paths are in [netdata.conf \[global\]](/daemon/config/README.md#global-section-options).
+
+## How Netdata configuration works
+
+The configuration files are `name = value` dictionaries with `[sections]`. Write whatever you like there as long as it
+follows this simple format.
+
+Netdata loads this dictionary and then when the code needs a value from it, it just looks up the `name` in the
+dictionary at the proper `section`. In all places, in the code, there are both the `names` and their `default values`,
+so if something is not found in the configuration file, the default is used. The lookup is made using B-Trees and hashes
+(no string comparisons), so they are super fast. Also the `names` of the settings can be `my super duper setting that
+once set to yes, will turn the world upside down = no` - so goodbye to most of the documentation involved.
+
+Next, Netdata can generate a valid configuration for the user to edit. No need to remember anything. Just get the
+configuration from the server (`/netdata.conf` on your Netdata server), edit it and save it.
+
+Last, what about options you believe you have set, but you misspelled?When you get the configuration file from the
+server, there will be a comment above all `name = value` pairs the server does not use. So you know that whatever you
+wrote there, is not used.
+
+## Netdata simple patterns
+
+Unix prefers regular expressions. But they are just too hard, too cryptic to use, write and understand.
+
+So, Netdata supports [simple patterns](/libnetdata/simple_pattern/README.md).
+
+## Netdata labels
+
+Beginning with 1.20, Netdata accepts user-defined **host labels**. These labels are defined in the section `[host
+labels]`.
+
+Read more about how these labels work and why they're an effective way to organize complex infrasturctures in our
+guide: [Use host labels to organize systems, metrics, and alarms](/docs/guides/using-host-labels.md).
+
+To define a label inside this section, some rules needs to be followed, or Netdata will reject the label. The following
+restrictions are applied for label names:
+
+- Names cannot start with `_`, but it can be present in other parts of the name.
+- Names only accept alphabet letters, numbers, dots, and dashes.
+
+The policy for values is more flexible, but you can not use exclamation marks (`!`), whitespaces (` `), single quotes
+(`'`), double quotes (`"`), or asterisks (`*`), because they are used to compare label values in health alarms and
+templates.
+
+[](<>)
diff --git a/docs/getting-started.md b/docs/getting-started.md
index 74597c10b3..1ccab4247b 100644
--- a/docs/getting-started.md
+++ b/docs/getting-started.md
@@ -1,9 +1,7 @@
<!--
----
title: "Get started guide"
date: 2020-05-04
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/getting-started.md
----
-->
# Get started guide
diff --git a/docs/guides/deploy/ansible.md b/docs/guides/deploy/ansible.md
index 887ba5e07a..8298fd00c8 100644
--- a/docs/guides/deploy/ansible.md
+++ b/docs/guides/deploy/ansible.md
@@ -1,6 +1,6 @@
<!--
title: Deploy Netdata with Ansible
-description: Deploy an infrastructure monitoring solution in minutes with the Netdata Agent and Ansible. Use and customize a simple playbook for monitoring as code.
+description: "Deploy an infrastructure monitoring solution in minutes with the Netdata Agent and Ansible. Use and customize a simple playbook for monitoring as code."
image: /img/seo/guides/deploy/ansible.png
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/deploy/ansible.md
-->
diff --git a/docs/guides/export/export-netdata-metrics-graphite.md b/docs/guides/export/export-netdata-metrics-graphite.md
index 4b11c3b15c..9a4a4f5ca6 100644
--- a/docs/guides/export/export-netdata-metrics-graphite.md
+++ b/docs/guides/export/export-netdata-metrics-graphite.md
@@ -1,6 +1,6 @@
<!--
title: Export and visualize Netdata metrics in Graphite
-description: Use Netdata to collect and export thousands of metrics to Graphite for long-term storage or further analysis.
+description: "Use Netdata to collect and export thousands of metrics to Graphite for long-term storage or further analysis."
image: /img/seo/guides/export/export-netdata-metrics-graphite.png
-->
diff --git a/docs/guides/monitor/dimension-templates.md b/docs/guides/monitor/dimension-templates.md
index 5fe3ae9632..da1faed8b4 100644
--- a/docs/guides/monitor/dimension-templates.md
+++ b/docs/guides/monitor/dimension-templates.md
@@ -1,8 +1,6 @@
<!--
----
title: "Use dimension templates to create dynamic alarms"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/monitor/health/dimension-templates.md
----
-->
# Use dimension templates to create dynamic alarms
diff --git a/docs/guides/monitor/stop-notifications-alarms.md b/docs/guides/monitor/stop-notifications-alarms.md
index bf897e0f57..587880ab11 100644
--- a/docs/guides/monitor/stop-notifications-alarms.md
+++ b/docs/guides/monitor/stop-notifications-alarms.md
@@ -1,8 +1,6 @@
<!--
----
title: "Stop notifications for individual alarms"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/monitor/stop-notifications-alarms.md
----
-->
# Stop notifications for individual alarms
diff --git a/docs/netdata-for-IoT.md b/docs/netdata-for-IoT.md
index abd2d5ddda..77b95229fd 100644
--- a/docs/netdata-for-IoT.md
+++ b/docs/netdata-for-IoT.md
@@ -1,8 +1,6 @@
<!--
----
title: "Netdata for IoT"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/netdata-for-IoT.md
----
-->
# Netdata for IoT
diff --git a/docs/netdata-security.md b/docs/netdata-security.md
index 97b9bae939..e020c0c8d2 100644
--- a/docs/netdata-security.md
+++ b/docs/netdata-security.md
@@ -1,8 +1,6 @@
<!--
----
title: "Security design"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/netdata-security.md
----
-->
# Security design
diff --git a/docs/privacy-policy.md b/docs/privacy-policy.md
index 561803783a..0152b0e0f5 100644
--- a/docs/privacy-policy.md
+++ b/docs/privacy-policy.md
@@ -1,8 +1,6 @@
<!--
----
title: "Privacy Policy"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/privacy-policy.md
----
-->
# Privacy Policy
diff --git a/docs/terms-of-use.md b/docs/terms-of-use.md
index 652dbc97f1..a3cbd0099c 100644
--- a/docs/terms-of-use.md
+++ b/docs/terms-of-use.md
@@ -1,8 +1,6 @@
<!--
----
title: "Terms of Use"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/terms-of-use.md
----
-->
# Terms of Use
diff --git a/docs/why-netdata/1s-granularity.md b/docs/why-netdata/1s-granularity.md
index bd0f9624d1..a2cc65b8f4 100644
--- a/docs/why-netdata/1s-granularity.md
+++ b/docs/why-netdata/1s-granularity.md
@@ -1,8 +1,6 @@
<!--
----
title: "1s granularity"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/why-netdata/1s-granularity.md
----
-->
# 1s granularity
diff --git a/docs/why-netdata/README.md b/docs/why-netdata/README.md
index d0c3206089..39cda51e23 100644
--- a/docs/why-netdata/README.md
+++ b/docs/why-netdata/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "Why Netdata"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/why-netdata/README.md
----
-->
# Why Netdata
diff --git a/docs/why-netdata/immediate-results.md b/docs/why-netdata/immediate-results.md
index 589f6afd1f..ba7c7d684a 100644
--- a/docs/why-netdata/immediate-results.md
+++ b/docs/why-netdata/immediate-results.md
@@ -1,8 +1,6 @@
<!--
----
title: "Immediate results"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/why-netdata/immediate-results.md
----
-->
# Immediate results
diff --git a/docs/why-netdata/meaningful-presentation.md b/docs/why-netdata/meaningful-presentation.md
index 4236fae4c5..64d83b4f62 100644
--- a/docs/why-netdata/meaningful-presentation.md
+++ b/docs/why-netdata/meaningful-presentation.md
@@ -1,8 +1,6 @@
<!--
----
title: "Meaningful presentation"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/why-netdata/meaningful-presentation.md
----
-->
# Meaningful presentation
diff --git a/docs/why-netdata/unlimited-metrics.md b/docs/why-netdata/unlimited-metrics.md
index 8c8e83f130..8e50062c7d 100644
--- a/docs/why-netdata/unlimited-metrics.md
+++ b/docs/why-netdata/unlimited-metrics.md
@@ -1,8 +1,6 @@
<!--
----
title: "Unlimited metrics"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/why-netdata/unlimited-metrics.md
----
-->
# Unlimited metrics
diff --git a/health/notifications/alerta/README.md b/health/notifications/alerta/README.md
index c40fa819ad..ff8c1aabbf 100644
--- a/health/notifications/alerta/README.md
+++ b/health/notifications/alerta/README.md
@@ -1,8 +1,7 @@
<!--
----
title: "alerta.io"
+description: "Send alarm notifications to Alerta to see the latest health status updates from multiple nodes in a single interface."
custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/alerta/README.md
----
-->
# alerta.io
diff --git a/health/notifications/awssns/README.md b/health/notifications/awssns/README.md
index 0ec785bc60..038d9bcc86 100644
--- a/health/notifications/awssns/README.md
+++ b/health/notifications/awssns/README.md
@@ -1,8 +1,7 @@
<!--
----
title: "Amazon SNS"
+description: "hello"
custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/awssns/README.md
----
-->
# Amazon SNS
diff --git a/health/notifications/custom/README.md b/health/notifications/custom/README.md
index 4c0049b9a5..04376d5552 100644
--- a/health/notifications/custom/README.md
+++ b/health/notifications/custom/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "Custom"
custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/custom/README.md
----
-->
# Custom
diff --git a/health/notifications/discord/README.md b/health/notifications/discord/README.md
index e8292aefe8..1650d9cec5 100644
--- a/health/notifications/discord/README.md
+++ b/health/notifications/discord/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "Discordapp.com"
custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/discord/README.md
----
-->
# Discordapp.com
diff --git a/health/notifications/dynatrace/README.md b/health/notifications/dynatrace/README.md
index 3f8ad85b6d..cc82ee78d7 100644
--- a/health/notifications/dynatrace/README.md
+++ b/health/notifications/dynatrace/README.md
@@ -32,3 +32,5 @@ The default value is `CUSTOM_INFO`.
This is a required parameter.
6. Specify the annotation type. This is the source of the Dynatrace event. Put whatever it fits you, for example,
_Netdata Alarm_, which is also the default value.
+
+[]()
diff --git a/health/notifications/email/README.md b/health/notifications/email/README.md
index 14c4b61c99..beac705439 100644
--- a/health/notifications/email/README.md
+++ b/health/notifications/email/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "Email"
custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/email/README.md
----
-->
# Email
diff --git a/health/notifications/irc/README.md b/health/notifications/irc/README.md
index 804d692a90..8ee440397b 100644
--- a/health/notifications/irc/README.md
+++ b/health/notifications/irc/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "IRC"
custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/irc/README.md
----
-->
# IRC
diff --git a/health/notifications/kavenegar/README.md b/health/notifications/kavenegar/README.md
index addb7b1b10..b59799fc2f 100644
--- a/health/notifications/kavenegar/README.md
+++ b/health/notifications/kavenegar/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "Kavenegar"
custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/kavenegar/README.md
----
-->
# Kavenegar
diff --git a/health/notifications/messagebird/README.md b/health/notifications/messagebird/README.md
index 4ac207fa42..8e3d1a5b39 100644
--- a/health/notifications/messagebird/README.md
+++ b/health/notifications/messagebird/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "Messagebird"
custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/messagebird/README.md
----
-->
# Messagebird
diff --git a/health/notifications/pagerduty/README.md b/health/notifications/pagerduty/README.md
index b90acf2051..b1f60d4951 100644
--- a/health/notifications/pagerduty/README.md
+++ b/health/notifications/pagerduty/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "PagerDuty"
custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/pagerduty/README.md
----
-->
# PagerDuty
diff --git a/health/notifications/prowl/README.md b/health/notifications/prowl/README.md
index 0d3868ae57..4c8bfe453f 100644
--- a/health/notifications/prowl/README.md
+++ b/health/notifications/prowl/README.md
@@ -25,3 +25,5 @@ the Prowl website after registering.
Once you have an API key, simply specify that as a recipient for Prowl
notifications.
+
+[]()
diff --git a/health/notifications/pushbullet/README.md b/health/notifications/pushbullet/README.md
index 00e948595e..7a098d6a0c 100644
--- a/health/notifications/pushbullet/README.md
+++ b/health/notifications/pushbullet/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "PushBullet"
custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/pushbullet/README.md
----
-->
# PushBullet
diff --git a/health/notifications/pushover/README.md b/health/notifications/pushover/README.md
index e1185a8fa6..3ba97fbc3e 100644
--- a/health/notifications/pushover/README.md
+++ b/health/notifications/pushover/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "PushOver"
custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/pushover/README.md
----
-->
# PushOver
diff --git a/health/notifications/rocketchat/README.md b/health/notifications/rocketchat/README.md
index 0d36b2c6fc..34a61aaf5b 100644
--- a/health/notifications/rocketchat/README.md
+++ b/health/notifications/rocketchat/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "Rocket.Chat"
custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/rocketchat/README.md
----
-->
# Rocket.Chat
diff --git a/health/notifications/slack/README.md b/health/notifications/slack/README.md
index ade25d345b..e338e9af00 100644
--- a/health/notifications/slack/README.md
+++ b/health/notifications/slack/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "Slack"
custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/slack/README.md
----
-->
# Slack
diff --git a/health/notifications/smstools3/README.md b/health/notifications/smstools3/README.md
index 158c79c8b0..6d90e702a5 100644
--- a/health/notifications/smstools3/README.md
+++ b/health/notifications/smstools3/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "SMS Server Tools 3"
custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/smstools3/README.md
----
-->
# SMS Server Tools 3
diff --git a/health/notifications/syslog/README.md b/health/notifications/syslog/README.md
index b08019c3f9..456394d2f7 100644
--- a/health/notifications/syslog/README.md
+++ b/health/notifications/syslog/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "Syslog"
custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/syslog/README.md
----
-->
# Syslog
diff --git a/health/notifications/telegram/README.md b/health/notifications/telegram/README.md
index f3323dd5ca..c1c6f2a4ee 100644
--- a/health/notifications/telegram/README.md
+++ b/health/notifications/telegram/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "Telegram"
custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/telegram/README.md
----
-->
# Telegram
diff --git a/health/notifications/twilio/README.md b/health/notifications/twilio/README.md
index b085aa6ef2..b36d40b994 100644
--- a/health/notifications/twilio/README.md
+++ b/health/notifications/twilio/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "Twilio"
custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/twilio/README.md
----
-->
# Twilio
diff --git a/health/notifications/web/README.md b/health/notifications/web/README.md
index 3e3e2de618..9e4918603f 100644
--- a/health/notifications/web/README.md
+++ b/health/notifications/web/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "Dashboard"
custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/web/README.md
----
-->
# Dashboard
diff --git a/libnetdata/README.md b/libnetdata/README.md
index 443058be55..cdb199f519 100644
--- a/libnetdata/README.md
+++ b/libnetdata/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "libnetdata"
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/README.md
----
-->
# libnetdata
diff --git a/libnetdata/adaptive_resortable_list/README.md b/libnetdata/adaptive_resortable_list/README.md
index b469f160df..74e379a925 100644
--- a/libnetdata/adaptive_resortable_list/README.md
+++ b/libnetdata/adaptive_resortable_list/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "Adaptive Re-sortable List (ARL)"
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/adaptive_resortable_list/README.md
----
-->
# Adaptive Re-sortable List (ARL)
diff --git a/libnetdata/avl/README.md b/libnetdata/avl/README.md
index 247db96674..2097be57f3 100644
--- a/libnetdata/avl/README.md
+++ b/libnetdata/avl/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "AVL"
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/avl/README.md
----
-->
# AVL
diff --git a/libnetdata/buffer/README.md b/libnetdata/buffer/README.md
index 00bf69ffbb..5a9d7b023d 100644
--- a/libnetdata/buffer/README.md
+++ b/libnetdata/buffer/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "BUFFER"
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/buffer/README.md
----
-->
# BUFFER
diff --git a/libnetdata/circular_buffer/README.md b/libnetdata/circular_buffer/README.md
index 7bc1672f46..d36c05f5a1 100644
--- a/libnetdata/circular_buffer/README.md
+++ b/libnetdata/circular_buffer/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "circular_buffer"
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/circular_buffer/README.md
----
-->
# Circular Buffer
@@ -11,3 +9,4 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/circu
and grow up to a maximum size as it fills. Two indices within the structure track the current
`read` and `write` position for data.
+[]()
diff --git a/libnetdata/config/README.md b/libnetdata/config/README.md
index 5cb475104b..a71f1ee181 100644
--- a/libnetdata/config/README.md
+++ b/libnetdata/config/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "Netdata ini config files"
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/config/README.md
----
-->
# Netdata ini config files
diff --git a/libnetdata/json/README.md b/libnetdata/json/README.md
index e3e813e4dc..79a48e2406 100644
--- a/libnetdata/json/README.md
+++ b/libnetdata/json/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "json"
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/json/README.md
----
-->
# json
diff --git a/libnetdata/procfile/README.md b/libnetdata/procfile/README.md
index f519eecb78..3eeb1e2057 100644
--- a/libnetdata/procfile/README.md
+++ b/libnetdata/procfile/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "PROCFILE"
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/procfile/README.md
----
-->
# PROCFILE
diff --git a/libnetdata/storage_number/README.md b/libnetdata/storage_number/README.md
index be6ba6ca87..295b3d6e76 100644
--- a/libnetdata/storage_number/README.md
+++ b/libnetdata/storage_number/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "Netdata storage number"
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/storage_number/README.md
----
-->
# Netdata storage number
diff --git a/packaging/DISTRIBUTIONS.md b/packaging/DISTRIBUTIONS.md
index b05e1ad66c..239113f9bc 100644
--- a/packaging/DISTRIBUTIONS.md
+++ b/packaging/DISTRIBUTIONS.md
@@ -1,8 +1,6 @@
<!--
----
title: "Netdata distribution support matrix"
custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/DISTRIBUTIONS.md
----
-->
# Netdata distribution support matrix
diff --git a/packaging/installer/README.md b/packaging/installer/README.md
index e9cf7465d0..317ac63801 100644
--- a/packaging/installer/README.md
+++ b/packaging/installer/README.md
@@ -249,3 +249,5 @@ issue altogether. Or, you can manually remove one version of OpenSSL to remove t
Our current build process has some issues when using certain configurations of the `clang` C compiler on Linux. See [the
section on `nonrepresentable section on output`
errors](/packaging/installer/methods/manual.md#nonrepresentable-section-on-output-errors) for a workaround.
+
+[](<>)
diff --git a/packaging/installer/UNINSTALL.md b/packaging/installer/UNINSTALL.md
index f900fe5cb3..c18a1bfc81 100644
--- a/packaging/installer/UNINSTALL.md
+++ b/packaging/installer/UNINSTALL.md
@@ -1,5 +1,6 @@
<!--
title: "Uninstall Netdata"
+description: "If you are no longer interested in using the Netdata Agent, use the self-contained uninstaller to remove all traces of binaries and configuration files."
custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/UNINSTALL.md
-->
diff --git a/packaging/installer/methods/alpine.md b/packaging/installer/methods/alpine.md
index 2337833939..fb448959a9 100644
--- a/packaging/installer/methods/alpine.md
+++ b/packaging/installer/methods/alpine.md
@@ -1,8 +1,6 @@
<!--
----
title: "Install Netdata on Alpine 3.x"
custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/alpine.md
----
-->
# Install Netdata on Alpine 3.x
@@ -34,3 +32,5 @@ chmod 755 /etc/local.d/netdata.stop
# enable the local service to start automatically
rc-update add local
```
+
+[](<>)
diff --git a/packaging/installer/methods/cloud-providers.md b/packaging/installer/methods/cloud-providers.md
index a67bc56d58..815eaa085c 100644
--- a/packaging/installer/methods/cloud-providers.md
+++ b/packaging/installer/methods/cloud-providers.md
@@ -1,8 +1,7 @@
<!--
----
title: "Install Netdata on cloud providers"
+description: "The Netdata Agent runs on all popular cloud providers, but often requires additional steps and configuration for full functionality."
custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/cloud-providers.md
----
-->
# Install Netdata on cloud providers
@@ -16,7 +15,7 @@ aims to document some of those steps for popular cloud providers.
> This document is a work-in-progress! If you find new issues specific to a cloud provider, or would like to help
> clarify the correct workaround, please [create an
-> issue](https://github.com/netdata/netdata/issues/new?labels=feature+request%2C+needs+triage&template=feature_request.md)
+> issue](https://github.com/netdata/netdata/issues/new?labels=feature+request,+needs+triage&template=feature_request.md)
> with your process and instructions on using the provider's interface to complete the workaround.
- [Recommended installation methods for cloud providers](#recommended-installation-methods-for-cloud-providers)
@@ -127,3 +126,5 @@ Name: Netdata
```
Click **Add** to apply your new inbound security rule.
+
+[](<>)
diff --git a/packaging/installer/methods/freebsd.md b/packaging/installer/methods/freebsd.md
index 86e5a2a443..e682e7e117 100644
--- a/packaging/installer/methods/freebsd.md
+++ b/packaging/installer/methods/freebsd.md
@@ -104,3 +104,5 @@ The `netdata-updater.sh` script will update your Agent.
| `--disable-x86-sse` | Disable SSE instructions. By default SSE optimizations are enabled|
| `--zlib-is-really-here` or `--libs-are-really-here` | If you get errors about missing zlib or libuuid but you know it is available, you might have a broken pkg-config. Use this option to proceed without checking pkg-config|
|`--disable-telemetry` | Use this flag to opt-out from our anonymous telemetry progam. (DO_NOT_TRACK=1)|
+
+[](<>)
diff --git a/packaging/installer/methods/freenas.md b/packaging/installer/methods/freenas.md
index de1fd59dd7..a0dafdff87 100644
--- a/packaging/installer/methods/freenas.md
+++ b/packaging/installer/methods/freenas.md
@@ -1,8 +1,6 @@
<!--
----
title: "Install Netdata on FreeNAS"
custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/freenas.md
----
-->
# Install Netdata on FreeNAS
@@ -22,3 +20,5 @@ To start the Netdata service:
```sh
service netdata start
```
+
+[](<>)
diff --git a/packaging/installer/methods/kickstart-64.md b/packaging/installer/methods/kickstart-64.md
index bd441411ca..b3f79278ef 100644
--- a/packaging/installer/methods/kickstart-64.md
+++ b/packaging/installer/methods/kickstart-64.md
@@ -1,8 +1,7 @@
<!--
----
title: "Install Netdata with kickstart-static64.sh"
+description: "The kickstart-static64.sh script installs a pre-compiled static binary, including all dependencies required to connect to Netdata Cloud, with one command."
custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/kickstart-64.md
----
-->
# Install Netdata with kickstart-static64.sh
@@ -93,3 +92,5 @@ Or, skip straight to [configuring the Netdata Agent](/docs/configure/nodes.md).
Read through Netdata's [documentation](https://learn.netdata.cloud/docs), which is structured based on actions and
solutions, to enable features like health monitoring, alarm notifications, long-term metrics storage, exporting to
external databases, and more.
+
+[](<>)
diff --git a/packaging/installer/methods/kickstart.md b/packaging/installer/methods/kickstart.md
index 3b3cc2cc7c..f753b6f63e 100644
--- a/packaging/installer/methods/kickstart.md
+++ b/packaging/installer/methods/kickstart.md
@@ -1,8 +1,7 @@
<!--
----
title: "Install Netdata with kickstart.sh"
+description: "The kickstart.sh script installs Netdata from source, including all dependencies required to connect to Netdata Cloud, with a single command."
custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/kickstart.md
----
-->
# Install Netdata with kickstart.sh
@@ -76,3 +75,5 @@ Or, skip straight to [configuring the Netdata Agent](/docs/configure/nodes.md).
Read through Netdata's [documentation](https://learn.netdata.cloud/docs), which is structured based on actions and
solutions, to enable features like health monitoring, alarm notifications, long-term metrics storage, exporting to
external databases, and more.
+
+[](<>)
diff --git a/packaging/installer/methods/macos.md b/packaging/installer/methods/macos.md
index 65c8344583..05883a7fe8 100644
--- a/packaging/installer/methods/macos.md
+++ b/packaging/installer/methods/macos.md
@@ -1,8 +1,6 @@
<!--
----
title: "Install Netdata on macOS"
custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/macos.md
----
-->
# Install Netdata on macOS
@@ -88,3 +86,5 @@ Or, skip straight to [configuring the Netdata Agent](/docs/configure/nodes.md).
Read through Netdata's [documentation](https://learn.netdata.cloud/docs), which is structured based on actions and
solutions, to enable features like health monitoring, alarm notifications, long-term metrics storage, exporting to
external databases, and more.
+
+[](<>)
diff --git a/packaging/installer/methods/manual.md b/packaging/installer/methods/manual.md
index e916bc95ae..40c1a0399f 100644
--- a/packaging/installer/methods/manual.md
+++ b/packaging/installer/methods/manual.md
@@ -1,8 +1,7 @@
<!--
----
title: "Install Netdata on Linux from a Git checkout"
+description: "Use the Netdata Agent source code from GitHub, plus helper scripts to set up your system, to install Netdata without packages or binaries."
custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/manual.md
----
-->
# Install Netdata on Linux from a Git checkout
@@ -226,3 +225,5 @@ Or, skip straight to [configuring the Netdata Agent](/docs/configure/nodes.md).
Read through Netdata's [documentation](https://learn.netdata.cloud/docs), which is structured based on actions and
solutions, to enable features like health monitoring, alarm notifications, long-term metrics storage, exporting to
external databases, and more.
+
+[](<>)
diff --git a/packaging/installer/methods/offline.md b/packaging/installer/methods/offline.md
index ddd252c6fa..4cf3c16b5f 100644
--- a/packaging/installer/methods/offline.md
+++ b/packaging/installer/methods/offline.md
@@ -1,24 +1,24 @@
<!--
----
title: "Install Netdata on offline systems"
+description: "Install the Netdata Agent on offline/air gapped systems to benefit from real-time, per-second monitoring without connecting to the internet."
custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/offline.md
----
-->
# Install Netdata on offline systems
-You can install Netdata on systems without internet access, but you need to take a few extra steps to make it work.
+The Netdata Agent installs on offline or air gapped systems with a few additional steps.
By default, the `kickstart.sh` and `kickstart-static64.sh` download Netdata assets, like the precompiled binary and a
-few dependencies, using the system's internet connection, but you can also supply these files from the local filesystem.
+few dependencies, using the system's internet connection, but the Agent installer can also use equivalent files already
+present on the local filesystem.
First, download the required files. If you're using `kickstart.sh`, you need the Netdata tarball, the checksums, the
go.d plugin binary, and the go.d plugin configuration. If you're using `kickstart-static64.sh`, you need only the
Netdata tarball and checksums.
-Download the files you need to a system of yours that's connected to the internet. You can use the commands below, or
-visit the [latest Netdata release page](https://github.com/netdata/netdata/releases/latest) and [latest go.d plugin
-release page](https://github.com/netdata/go.d.plugin/releases) to download the required files manually.
+Download the files you need to a system of yours that's connected to the internet. Use the commands below, or visit the
+[latest Netdata release page](https://github.com/netdata/netdata/releases/latest) and [latest go.d plugin release
+page](https://github.com/netdata/go.d.plugin/releases) to download the required files manually.
**If you're using `kickstart.sh`**, use the following commands:
@@ -78,6 +78,7 @@ bash kickstart-static64.sh --local-files /tmp/netdata-(version-number-here).gz.r
## What's next?
+<<<<<<< HEAD
When you're finished with installation, check out our [single-node](/docs/quickstart/single-node.md) or
[infrastructure](/docs/quickstart/infrastructure.md) monitoring quickstart guides based on your use case.
@@ -86,3 +87,9 @@ Or, skip straight to [configuring the Netdata Agent](/docs/configure/nodes.md).
Read through Netdata's [documentation](https://learn.netdata.cloud/docs), which is structured based on actions and
solutions, to enable features like health monitoring, alarm notifications, long-term metrics storage, exporting to
external databases, and more.
+=======
+Or, get the full guided tour of Netdata's capabilities with our [step-by-step
+guide](/docs/guides/step-by-step/step-00.md)!
+
+[]()
+>>>>>>> dda27d9c (First pass to get the script working right)
diff --git a/packaging/installer/methods/packages.md b/packaging/installer/methods/packages.md
index 7405eeadb2..1fa2f9cf83 100644
--- a/packaging/installer/methods/packages.md
+++ b/packaging/installer/methods/packages.md
@@ -1,6 +1,6 @@
<!--
title: "Install Netdata with .deb/.rpm packages"
-desciption: "Install the Netdata Agent with Linux packages that support Ubuntu, Debian, Fedora, RHEL, CentOS, openSUSE, and more."
+description: "Install the Netdata Agent with Linux packages that support Ubuntu, Debian, Fedora, RHEL, CentOS, openSUSE, and more."
custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/packages.md
-->
@@ -25,13 +25,13 @@ packagecloud only provides HTTPS access to repositories they host, which means i
repositories are only accessible via HTTPS. This is known to cause issues with some setups that use a caching proxy for
package downloads.
-If you are using such a setup, there are a couple of ways you can work around this:
+If you are using such a setup, there are a couple of ways to work around this:
- Configure your proxy to automatically pass through HTTPS connections without caching them. This is the simplest
solution, but means that downloads of Netdata pacakges will not be cached.
- Mirror the respository locally on your proxy system, and use that mirror when installing on other systems. This
requires more setup and more disk space on the caching host, but it lets you cache the packages locally.
-- Some specific caching proxies may have alternative configuration options to deal with these issues. You can find
+- Some specific caching proxies may have alternative configuration options to deal with these issues. Find
such options in their documentation.
## What's next?
@@ -44,3 +44,5 @@ Or, skip straight to [configuring the Netdata Agent](/docs/configure/nodes.md).
Read through Netdata's [documentation](https://learn.netdata.cloud/docs), which is structured based on actions and
solutions, to enable features like health monitoring, alarm notifications, long-term metrics storage, exporting to
external databases, and more.
+
+[]()
diff --git a/packaging/installer/methods/pfsense.md b/packaging/installer/methods/pfsense.md
index 95f5d7a476..fa490f6511 100644
--- a/packaging/installer/methods/pfsense.md
+++ b/packaging/installer/methods/pfsense.md
@@ -80,3 +80,5 @@ If you experience an issue with `/usr/bin/install` being absent in pfSense 2.3 o
workaround from <https://redmine.pfsense.org/issues/6643>
**Note:** In pfSense, the Netdata configuration files are located under `/usr/local/etc/netdata`.
+
+[](<>)
diff --git a/packaging/installer/methods/source.md b/packaging/installer/methods/source.md
index 556bc3bbb6..929252426e 100644
--- a/packaging/installer/methods/source.md
+++ b/packaging/installer/methods/source.md
@@ -1,7 +1,7 @@
<!--
title: "Manually build Netdata from source"
-custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/source.md
description: "Package maintainers and power users may be interested in manually building Netdata from source without using any of our installation scripts."
+custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/source.md
-->
# Manually build Netdata from source
@@ -288,4 +288,4 @@ repository](https://github.com/netdata/kernel-collector/blob/master/README.md),
which outlines both the required dependencies, as well as multiple
options for building the code.
-[](<>)
+[](<>)
diff --git a/packaging/installer/methods/synology.md b/packaging/installer/methods/synology.md
index d404534481..4a0ae3551a 100644
--- a/packaging/installer/methods/synology.md
+++ b/packaging/installer/methods/synology.md
@@ -1,8 +1,7 @@
<!--
----
title: "Install Netdata on Synology"
+description: "The Netdata Agent can be installed on AMD64-compatible NAS systems using the 64-bit pre-compiled static binary."
custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/synology.md
----
-->
# Install Netdata on Synology
@@ -49,3 +48,5 @@ installed. You'll have to do this manually:
```
3. Make sure `/etc/rc.netdata` is executable: `chmod 0755 /etc/rc.netdata`.
+
+[](<>)
diff --git a/packaging/maintainers/README.md b/packaging/maintainers/README.md
index 5bea502e79..72f7e61c8e 100644
--- a/packaging/maintainers/README.md
+++ b/packaging/maintainers/README.md
@@ -1,9 +1,7 @@
<!--
----
title: "Package Maintainers"
date: 2020-03-31
custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/maintainers/README.md
----
-->
# Package Maintainers
diff --git a/packaging/makeself/README.md b/packaging/makeself/README.md
index 75d0f38790..a265914cb3 100644
--- a/packaging/makeself/README.md
+++ b/packaging/makeself/README.md
@@ -1,8 +1,7 @@
<!--
----
title: "Netdata static binary build"
+description: "Users can build the static 64-bit binary package that we ship with every release of the open-source Netdata Agent for debugging or specialize purposes."
custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/makeself/README.md
----
-->
# Netdata static binary build
diff --git a/parser/README.md b/parser/README.md
index a865514fb6..3bc48bc906 100644
--- a/parser/README.md
+++ b/parser/README.md
@@ -144,4 +144,6 @@ Output
- The parser is deallocated
Returns
-- none
\ No newline at end of file
+- none
+
+[]()
diff --git a/registry/README.md b/registry/README.md
index 534c4f7c39..968292c0b8 100644
--- a/registry/README.md
+++ b/registry/README.md
@@ -1,8 +1,7 @@
<!--
----
title: "Registry"
+description: "Netdata utilizes a central registry of machines/person GUIDs, URLs, and opt-in account information to provide unified cross-server dashboards."
custom_edit_url: https://github.com/netdata/netdata/edit/master/registry/README.md
----
-->
# Registry
diff --git a/tests/README.md b/tests/README.md
index 3a127cbcaf..256b482cfa 100644
--- a/tests/README.md
+++ b/tests/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "Testing"
custom_edit_url: https://github.com/netdata/netdata/edit/master/tests/README.md
----
-->
# Testing
diff --git a/tests/health_mgmtapi/README.md b/tests/health_mgmtapi/README.md
index 593ebc03c6..1a4b2b146b 100644
--- a/tests/health_mgmtapi/README.md
+++ b/tests/health_mgmtapi/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "Health command API tester"
custom_edit_url: https://github.com/netdata/netdata/edit/master/tests/health_mgmtapi/README.md
----
-->
# Health command API tester
diff --git a/web/api/badges/README.md b/web/api/badges/README.md
index a6c63e26b9..582c80c611 100644
--- a/web/api/badges/README.md
+++ b/web/api/badges/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "Netdata badges"
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/badges/README.md
----
-->
# Netdata badges
diff --git a/web/api/exporters/README.md b/web/api/exporters/README.md
index cd3f085ca6..4019647440 100644
--- a/web/api/exporters/README.md
+++ b/web/api/exporters/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "Exporters"
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/exporters/README.md
----
-->
# Exporters
diff --git a/web/api/exporters/prometheus/README.md b/web/api/exporters/prometheus/README.md
index 30d93815fa..d26c6e4695 100644
--- a/web/api/exporters/prometheus/README.md
+++ b/web/api/exporters/prometheus/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "prometheus exporter"
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/exporters/prometheus/README.md
----
-->
# prometheus exporter
diff --git a/web/api/exporters/shell/README.md b/web/api/exporters/shell/README.md
index f5d2025965..b919045f23 100644
--- a/web/api/exporters/shell/README.md
+++ b/web/api/exporters/shell/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "shell exporter"
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/exporters/shell/README.md
----
-->
# shell exporter
diff --git a/web/api/formatters/README.md b/web/api/formatters/README.md
index c6d21214d9..1fd2b30294 100644
--- a/web/api/formatters/README.md
+++ b/web/api/formatters/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "Query formatting"
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/formatters/README.md
----
-->
# Query formatting
diff --git a/web/api/formatters/csv/README.md b/web/api/formatters/csv/README.md
index 8a166333bc..2a859e2498 100644
--- a/web/api/formatters/csv/README.md
+++ b/web/api/formatters/csv/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "CSV formatter"
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/formatters/csv/README.md
----
-->
# CSV formatter
diff --git a/web/api/formatters/json/README.md b/web/api/formatters/json/README.md
index b0a76bf58c..685a3f2dfa 100644
--- a/web/api/formatters/json/README.md
+++ b/web/api/formatters/json/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "JSON formatter"
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/formatters/json/README.md
----
-->
# JSON formatter
diff --git a/web/api/formatters/ssv/README.md b/web/api/formatters/ssv/README.md
index c2f373321b..d439949a58 100644
--- a/web/api/formatters/ssv/README.md
+++ b/web/api/formatters/ssv/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "SSV formatter"
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/formatters/ssv/README.md
----
-->
# SSV formatter
diff --git a/web/api/formatters/value/README.md b/web/api/formatters/value/README.md
index 3e4d2ab838..21c937080f 100644
--- a/web/api/formatters/value/README.md
+++ b/web/api/formatters/value/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "Value formatter"
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/formatters/value/README.md
----
-->
# Value formatter
diff --git a/web/api/health/README.md b/web/api/health/README.md
index c3852640b0..b007ef1f55 100644
--- a/web/api/health/README.md
+++ b/web/api/health/README.md
@@ -1,9 +1,7 @@
<!--
----
title: "Health API Calls"
date: 2020-04-27
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/health/README.md
----
-->
# Health API Calls
diff --git a/web/api/queries/README.md b/web/api/queries/README.md
index 4565abaa80..31ec496558 100644
--- a/web/api/queries/README.md
+++ b/web/api/queries/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "Database Queries"
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/queries/README.md
----
-->
# Database Queries
diff --git a/web/api/queries/average/README.md b/web/api/queries/average/README.md
index f85dd51e1a..f32a67571d 100644
--- a/web/api/queries/average/README.md
+++ b/web/api/queries/average/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "Average or Mean"
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/queries/average/README.md
----
-->
# Average or Mean
diff --git a/web/api/queries/des/README.md b/web/api/queries/des/README.md
index 157bad36a1..5505de5a69 100644
--- a/web/api/queries/des/README.md
+++ b/web/api/queries/des/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "double exponential smoothing"
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/queries/des/README.md
----
-->
# double exponential smoothing
diff --git a/web/api/queries/incremental_sum/README.md b/web/api/queries/incremental_sum/README.md
index 743e95b627..e5f3dfc0cc 100644
--- a/web/api/queries/incremental_sum/README.md
+++ b/web/api/queries/incremental_sum/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "Incremental Sum (`incremental_sum`)"
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/queries/incremental_sum/README.md
----
-->
# Incremental Sum (`incremental_sum`)
diff --git a/web/api/queries/max/README.md b/web/api/queries/max/README.md
index a2d2e98460..32b1d434cb 100644
--- a/web/api/queries/max/README.md
+++ b/web/api/queries/max/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "Max"
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/queries/max/README.md
----
-->
# Max
diff --git a/web/api/queries/median/README.md b/web/api/queries/median/README.md
index 25c1a3f824..d42d90c0a6 100644
--- a/web/api/queries/median/README.md
+++ b/web/api/queries/median/README.md
@@ -1,8 +1,7 @@
<!--
----
title: "Median"
+description: "Use median in API queries and health entities to find the "middle" value from a sample, eliminating any unwanted spikes in the returned metrics."
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/queries/median/README.md
----
-->
# Median
diff --git a/web/api/queries/min/README.md b/web/api/queries/min/README.md
index 7c84f1446f..69ef4ea127 100644
--- a/web/api/queries/min/README.md
+++ b/web/api/queries/min/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "Min"
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/queries/min/README.md
----
-->
# Min
diff --git a/web/api/queries/ses/README.md b/web/api/queries/ses/README.md
index d9ed1483cc..c279701358 100644
--- a/web/api/queries/ses/README.md
+++ b/web/api/queries/ses/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "Single (or Simple) Exponential Smoothing (`ses`)"
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/queries/ses/README.md
----
-->
# Single (or Simple) Exponential Smoothing (`ses`)
diff --git a/web/api/queries/stddev/README.md b/web/api/queries/stddev/README.md
index aef0b66f73..7cd7d62af0 100644
--- a/web/api/queries/stddev/README.md
+++ b/web/api/queries/stddev/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "standard deviation (`stddev`)"
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/queries/stddev/README.md
----
-->
# standard deviation (`stddev`)
diff --git a/web/api/queries/sum/README.md b/web/api/queries/sum/README.md
index 195d934f4f..aeace0a168 100644
--- a/web/api/queries/sum/README.md
+++ b/web/api/queries/sum/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "Sum"
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/queries/sum/README.md
----
-->
# Sum
diff --git a/web/gui/confluence/README.md b/web/gui/confluence/README.md
index 0547abbfd4..2e929e7d14 100644
--- a/web/gui/confluence/README.md
+++ b/web/gui/confluence/README.md
@@ -1,8 +1,6 @@
<!--
----
title: "Atlassian Confluence dashboards"
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/gui/confluence/README.md
----
-->
# Atlassian Confluence dashboards
diff --git a/web/gui/custom/README.md b/web/gui/custom/README.md
index c1d4206cdb..a85c7f5464 100644
--- a/web/gui/custom/README.md
+++ b/web/gui/custom/README.md
@@ -1,8 +1,7 @@
<!--
----
title: "Custom dashboards"
+description: "Build custom dashboards with key metrics from one or more nodes running the Netdata Agent and host them anywhere."
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/gui/custom/README.md
----
-->
# Custom dashboards
diff --git a/web/server/README.md b/web/server/README.md
index 89bfe69d8d..fbf3151ba2 100644
--- a/web/server/README.md
+++ b/web/server/README.md
@@ -1,8 +1,7 @@
<!--
----
title: "Web server"
+description: "The Netdata Agent's local static-threaded web server serves dashboards and real-time visualizations with security and DDoS protection."
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/server/README.md
----
-->
# Web server
@@ -12,14 +11,14 @@ It uses non-blocking I/O and respects the `keep-alive` HTTP header to serve mult
## Configuration
-You can disable the web server by editing `netdata.conf` and setting:
+Disable the web server by editing `netdata.conf` and setting:
```
[web]
mode = none
```
-With the web server enabled, you can control the number of threads and sockets with the following settings:
+With the web server enabled, control the number of threads and sockets with the following settings:
```
[web]
@@ -33,7 +32,7 @@ The `web server max sockets` setting is automatically adjusted to 50% of the max
### Binding Netdata to multiple ports
-Netdata can bind to multiple IPs and ports, offering access to different services on each. Up to 100 sockets can be used (you can increase it at compile time with `CFLAGS="-DMAX_LISTEN_FDS=200" ./netdata-installer.sh ...`).
+Netdata can bind to multiple IPs and ports, offering access to different services on each. Up to 100 sockets can be used (increase it at compile time with `CFLAGS="-DMAX_LISTEN_FDS=200" ./netdata-installer.sh ...`).
The ports to bind are controlled via `[web].bind to`, like this:
@@ -87,14 +86,14 @@ To enable TLS, provide the path to your certificate and private key in the `[web
Both files must be readable by the `netdata` user. If either of these files do not exist or are unreadable, Netdata will fall back to HTTP. For a parent-child connection, only the parent needs these settings.
-For test purposes, you can generate self-signed certificates with the following command:
+For test purposes, generate self-signed certificates with the following command:
```bash
openssl req -newkey rsa:2048 -nodes -sha512 -x509 -days 365 -keyout key.pem -out cert.pem
```
> If you use 4096 bits for your key and the certificate, Netdata will need more CPU to process the communication.
-> `rsa4096` can be up to 4 times slower than `rsa2048`, so we recommend using 2048 bits. You can verify the difference
+> `rsa4096` can be up to 4 times slower than `rsa2048`, so we recommend using 2048 bits. Verify the difference
> by running:
>
> ```sh
@@ -103,7 +102,7 @@ openssl req -newkey rsa:2048 -nodes -sha512 -x509 -days 365 -keyout key.pem -out
### Select TLS version
-Beginning with version 1.21, you can also specify the TLS version and the ciphers that you want to use:
+Beginning with version 1.21, specify the TLS version and the ciphers that you want to use:
```conf
[web]
@@ -122,7 +121,7 @@ When the certificates are defined and unless any other options are provided, a N
- Redirect all incoming HTTP web server requests to HTTPS. Applies to the dashboard, the API, `netdata.conf` and badges.
- Allow incoming child connections to use both unencrypted and encrypted communications for streaming.
-To change this behavior, you need to modify the `bind to` setting in the `[web]` section of `netdata.conf`. At the end of each port definition, you can append `^SSL=force` or `^SSL=optional`. What happens with these settings differs, depending on whether the port is used for HTTP/S requests, or for streaming.
+To change this behavior, you need to modify the `bind to` setting in the `[web]` section of `netdata.conf`. At the end of each port definition, append `^SSL=force` or `^SSL=optional`. What happens with these settings differs, depending on whether the port is used for HTTP/S requests, or for streaming.
| SSL setting | HTTP requests|HTTPS requests|Unencrypted Streams|Encrypted Streams|
|:---------:|:-----------:|:------------:|:-----------------:|:----------------|
@@ -159,7 +158,7 @@ When you start using Netdata with TLS, you may find errors in the Netdata log, w
Most of the time, these errors are due to incompatibilities between your browser's options related to TLS/SSL protocols and Netdata's internal configuration. The most common error is `error:00000006:lib(0):func(0):EVP lib`.
-In the near future, Netdata will allow our users to change the internal configuration to avoid similar errors. Until then, we're recommending only the most common and safe encryption protocols, which you can find above.
+In the near future, Netdata will allow our users to change the internal configuration to avoid similar errors. Until then, we're recommending only the most common and safe encryption protocols listed above.
### Access lists
diff --git a/web/server/static/README.md b/web/server/static/README.md
index fe28a4313b..63edd9ba7e 100644
--- a/web/server/static/README.md
+++ b/web/server/static/README.md
@@ -1,8 +1,7 @@
<!--
----
title: "`static-threaded` web server"
+description: "The Netdata Agent's static-threaded web server spawns a fixed nubmer of threads that listen to web requests and uses non-blocking I/O."
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/server/static/README.md
----
-->
# `static-threaded` web server
@@ -14,4 +13,5 @@ The kernel distributes the incoming requests to them.
Each thread uses non-blocking I/O so it can serve any number of web requests in parallel.
This web server respects the `keep-alive` HTTP header to serve multiple HTTP requests via the same connection.
+
[](<>)