summaryrefslogtreecommitdiffstats
path: root/web
diff options
context:
space:
mode:
authorJoel Hans <joel@netdata.cloud>2021-01-07 11:44:43 -0700
committerGitHub <noreply@github.com>2021-01-07 11:44:43 -0700
commit46a8075c8ff6da974d1b39f5b3b9eb50385892c1 (patch)
tree53ee29b1928ef3d13a3c941c52c9f56868bf918c /web
parent0bb7a429b619bc68104983691e4f957482630787 (diff)
Docs housekeeping for SEO and syntax, part 1 (#10388)
* First pass to get the script working right * Finish adding analytics tags
Diffstat (limited to 'web')
-rw-r--r--web/api/badges/README.md2
-rw-r--r--web/api/exporters/README.md2
-rw-r--r--web/api/exporters/prometheus/README.md2
-rw-r--r--web/api/exporters/shell/README.md2
-rw-r--r--web/api/formatters/README.md2
-rw-r--r--web/api/formatters/csv/README.md2
-rw-r--r--web/api/formatters/json/README.md2
-rw-r--r--web/api/formatters/ssv/README.md2
-rw-r--r--web/api/formatters/value/README.md2
-rw-r--r--web/api/health/README.md2
-rw-r--r--web/api/queries/README.md2
-rw-r--r--web/api/queries/average/README.md2
-rw-r--r--web/api/queries/des/README.md2
-rw-r--r--web/api/queries/incremental_sum/README.md2
-rw-r--r--web/api/queries/max/README.md2
-rw-r--r--web/api/queries/median/README.md3
-rw-r--r--web/api/queries/min/README.md2
-rw-r--r--web/api/queries/ses/README.md2
-rw-r--r--web/api/queries/stddev/README.md2
-rw-r--r--web/api/queries/sum/README.md2
-rw-r--r--web/gui/confluence/README.md2
-rw-r--r--web/gui/custom/README.md3
-rw-r--r--web/server/README.md19
-rw-r--r--web/server/static/README.md4
24 files changed, 13 insertions, 56 deletions
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.
+
[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fweb%2Fserver%2Fstatic%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)