Skip to content

Commit

Permalink
Docs housekeeping for SEO and syntax, part 1 (netdata#10388)
Browse files Browse the repository at this point in the history
* First pass to get the script working right

* Finish adding analytics tags
  • Loading branch information
joelhans authored Jan 7, 2021
1 parent 0bb7a42 commit 46a8075
Show file tree
Hide file tree
Showing 151 changed files with 344 additions and 303 deletions.
9 changes: 5 additions & 4 deletions BREAKING_CHANGES.md
Original file line number Diff line number Diff line change
@@ -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)]

[![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%2BREAKING_CHANGES&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)
3 changes: 1 addition & 2 deletions BUILD.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
<!--
---
title: "The build system"
custom_edit_url: https://github.com/netdata/netdata/edit/master/BUILD.md
---
-->

# The build system
Expand Down Expand Up @@ -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)
[![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%2FBUILD&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)
2 changes: 0 additions & 2 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 0 additions & 2 deletions REDISTRIBUTED.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
<!--
---
title: "Redistributed software"
custom_edit_url: https://github.com/netdata/netdata/edit/master/REDISTRIBUTED.md
---
-->

# Redistributed software
Expand Down
3 changes: 1 addition & 2 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 0 additions & 2 deletions backends/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 0 additions & 2 deletions backends/TIMESCALE.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 0 additions & 2 deletions backends/WALKTHROUGH.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 0 additions & 2 deletions backends/aws_kinesis/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 0 additions & 2 deletions backends/mongodb/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
<!--
---
title: "MongoDB backend"
custom_edit_url: https://github.com/netdata/netdata/edit/master/backends/mongodb/README.md
---
-->

# MongoDB backend
Expand Down
4 changes: 2 additions & 2 deletions backends/opentsdb/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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.

[![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%2Fbackends%2Fopentsdb%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)]()
2 changes: 0 additions & 2 deletions backends/prometheus/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 0 additions & 2 deletions backends/prometheus/remote_write/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
3 changes: 1 addition & 2 deletions build_external/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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).

[![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%2Fbuild_external%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)]()
2 changes: 1 addition & 1 deletion claim/README.md
Original file line number Diff line number Diff line change
@@ -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
-->

Expand Down
9 changes: 4 additions & 5 deletions cli/README.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
4 changes: 2 additions & 2 deletions collectors/QUICKSTART.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
<!--
---
title: "Collectors quickstart"
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/QUICKSTART.md
---
-->

# Collectors quickstart
Expand Down Expand Up @@ -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).

[![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%2Fcollectors%2FQUICKSTART&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)]()
2 changes: 0 additions & 2 deletions collectors/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
<!--
---
title: "Collecting metrics"
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/README.md
---
-->

# Collecting metrics
Expand Down
4 changes: 2 additions & 2 deletions collectors/REFERENCE.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
<!--
---
title: "Collectors configuration reference"
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/REFERENCE.md
---
-->

# Collectors configuration reference
Expand Down Expand Up @@ -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/).

[![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%2Fcollectors%2REFERENCE&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)]()
2 changes: 0 additions & 2 deletions collectors/cgroups.plugin/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
<!--
---
title: "cgroups.plugin"
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/cgroups.plugin/README.md
---
-->

# cgroups.plugin
Expand Down
2 changes: 0 additions & 2 deletions collectors/checks.plugin/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
<!--
---
title: "checks.plugin"
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/checks.plugin/README.md
---
-->

# checks.plugin
Expand Down
4 changes: 2 additions & 2 deletions collectors/cups.plugin/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
<!--
---
title: "cups.plugin"
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/cups.plugin/README.md
---
-->

# cups.plugin
Expand Down Expand Up @@ -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.

[![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%2Fcollectors%2cups.plugin%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)]()
3 changes: 1 addition & 2 deletions collectors/diskspace.plugin/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 0 additions & 2 deletions collectors/fping.plugin/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
<!--
---
title: "fping.plugin"
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/fping.plugin/README.md
---
-->

# fping.plugin
Expand Down
2 changes: 0 additions & 2 deletions collectors/freebsd.plugin/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
<!--
---
title: "freebsd.plugin"
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/freebsd.plugin/README.md
---
-->

# freebsd.plugin
Expand Down
2 changes: 0 additions & 2 deletions collectors/freeipmi.plugin/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
<!--
---
title: "freeipmi.plugin"
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/freeipmi.plugin/README.md
---
-->

# freeipmi.plugin
Expand Down
2 changes: 0 additions & 2 deletions collectors/idlejitter.plugin/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
<!--
---
title: "idlejitter.plugin"
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/idlejitter.plugin/README.md
---
-->

# idlejitter.plugin
Expand Down
2 changes: 0 additions & 2 deletions collectors/ioping.plugin/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
<!--
---
title: "ioping.plugin"
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/ioping.plugin/README.md
---
-->

# ioping.plugin
Expand Down
2 changes: 0 additions & 2 deletions collectors/macos.plugin/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
<!--
---
title: "macos.plugin"
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/macos.plugin/README.md
---
-->

# macos.plugin
Expand Down
2 changes: 0 additions & 2 deletions collectors/nfacct.plugin/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
<!--
---
title: "nfacct.plugin"
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/nfacct.plugin/README.md
---
-->

# nfacct.plugin
Expand Down
2 changes: 0 additions & 2 deletions collectors/perf.plugin/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
<!--
---
title: "perf.plugin"
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/perf.plugin/README.md
---
-->

# perf.plugin
Expand Down
2 changes: 0 additions & 2 deletions collectors/plugins.d/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 0 additions & 2 deletions collectors/proc.plugin/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
<!--
---
title: "proc.plugin"
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/proc.plugin/README.md
---
-->

# proc.plugin
Expand Down
2 changes: 2 additions & 0 deletions collectors/python.d.plugin/alarms/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`

[![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%2Fcollectors%2Fpython.d.plugin%2Falarms%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)]()
2 changes: 2 additions & 0 deletions collectors/python.d.plugin/am2320/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,3 +50,5 @@ Software install:
- save the file.
- restart the netdata service.
- check the dashboard.

[![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%2Fcollectors%2Fpython.d.plugin%2Fam2320%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)]()
2 changes: 2 additions & 0 deletions collectors/python.d.plugin/anomalies/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

[![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%2Fcollectors%2Fpython.d.plugin%2Fanomalies%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)]()
2 changes: 1 addition & 1 deletion collectors/python.d.plugin/gearman/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,4 @@ localhost:
When no configuration file is found, module tries to connect to TCP/IP socket: `localhost:4730`.

---
[![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%2Fcollectors%2Fpython.d.plugin%2Fgearman%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)]()
2 changes: 2 additions & 0 deletions collectors/python.d.plugin/hpssa/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,3 +51,5 @@ If `ssacli` cannot be found in the `PATH`, configure it in `hpssa.conf`.
```yaml
ssacli_path: /usr/sbin/ssacli
```

[![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%2Fcollectors%2Fpython.d.plugin%2Fhpssa%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)]()
2 changes: 2 additions & 0 deletions collectors/python.d.plugin/riakkv/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

[![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%2Fcollectors%2Fpython.d.plugin%2Friakkv%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)]()
2 changes: 0 additions & 2 deletions collectors/slabinfo.plugin/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
<!--
---
title: "slabinfo.plugin"
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/slabinfo.plugin/README.md
---
-->

# slabinfo.plugin
Expand Down
Loading

0 comments on commit 46a8075

Please sign in to comment.