summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChris Akritidis <43294513+cakrit@users.noreply.github.com>2023-02-20 08:56:06 -0800
committerGitHub <noreply@github.com>2023-02-20 08:56:06 -0800
commit157c0fa16bac2095ee911b8d6f96a782211c0849 (patch)
tree3c072168ea04853c0b840c45b9ad2204d1f69722
parentb6054473e014d6a0d60bedffc80a3c87ab54fab0 (diff)
Remove References category from learn (#14571)
-rw-r--r--cli/README.md9
-rw-r--r--daemon/README.md3
-rw-r--r--daemon/config/README.md3
-rw-r--r--docs/anonymous-statistics.md14
-rw-r--r--docs/category-overview-pages/developers-overview.md4
-rw-r--r--docs/category-overview-pages/integrations-overview.md1
-rw-r--r--docs/category-overview-pages/misc-overview.md1
-rw-r--r--docs/category-overview-pages/references-overview.md4
-rw-r--r--docs/dashboard/reference-web-server.md3
-rw-r--r--docs/metrics-storage-management/reference-streaming.md3
-rw-r--r--registry/README.md3
-rw-r--r--streaming/README.md8
-rw-r--r--web/gui/README.md3
-rw-r--r--web/server/README.md3
14 files changed, 26 insertions, 36 deletions
diff --git a/cli/README.md b/cli/README.md
index 09f2017459..4844f592f7 100644
--- a/cli/README.md
+++ b/cli/README.md
@@ -1,15 +1,16 @@
<!--
-title: "Netdata CLI"
+title: "Netdata Agent 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"
sidebar_label: "Agent CLI"
learn_status: "Published"
-learn_topic_type: "References"
-learn_rel_path: "References"
+learn_rel_path: "Operations"
-->
# Netdata CLI
+The `netdatacli` executable provides a simple way to control the Netdata agent's operation.
+
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`.
@@ -39,6 +40,6 @@ aclk-state [json]
Returns current state of ACLK and Cloud connection. (optionally in json)
```
-Those commands are the same that can be sent to netdata via [signals](https://github.com/netdata/netdata/blob/master/daemon/README.md#command-line-options).
+See also the Netdata daemon [command line options](https://github.com/netdata/netdata/blob/master/daemon/README.md#command-line-options).
diff --git a/daemon/README.md b/daemon/README.md
index 7a17506bb6..ab7be11a1c 100644
--- a/daemon/README.md
+++ b/daemon/README.md
@@ -4,8 +4,7 @@ date: "2020-04-29"
custom_edit_url: "https://github.com/netdata/netdata/edit/master/daemon/README.md"
sidebar_label: "Netdata daemon"
learn_status: "Published"
-learn_topic_type: "References"
-learn_rel_path: "References/Configuration"
+learn_rel_path: "Operations"
-->
# Netdata daemon
diff --git a/daemon/config/README.md b/daemon/config/README.md
index 4a6d0bb804..abaaf10c81 100644
--- a/daemon/config/README.md
+++ b/daemon/config/README.md
@@ -4,8 +4,7 @@ description: "The Netdata Agent's daemon is installed preconfigured to collect t
custom_edit_url: "https://github.com/netdata/netdata/edit/master/daemon/config/README.md"
sidebar_label: "Daemon"
learn_status: "Published"
-learn_topic_type: "References"
-learn_rel_path: "References/Configuration"
+learn_rel_path: "Configuration"
learn_doc_purpose: "Explain the daemon options, the log files, the process scheduling, virtual memory, explain how the netdata.conf is used and backlink to the netdata.conf file reference"
-->
diff --git a/docs/anonymous-statistics.md b/docs/anonymous-statistics.md
index 950f44e12f..512cd02d33 100644
--- a/docs/anonymous-statistics.md
+++ b/docs/anonymous-statistics.md
@@ -1,13 +1,12 @@
<!--
-title: "Anonymous statistics"
+title: "Anonymous telemetry events"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/anonymous-statistics.md
-sidebar_label: "Anonymous statistics"
+sidebar_label: "Anonymous telemetry events"
learn_status: "Published"
-learn_topic_type: "References"
-learn_rel_path: "References"
+learn_rel_path: "Configuration"
-->
-# Anonymous statistics
+# Anonymous telemetry events
By default, Netdata collects anonymous usage information from the open-source monitoring agent using the open-source
product analytics platform [PostHog](https://github.com/PostHog/posthog). We use their [cloud enterprise platform](https://posthog.com/product).
@@ -101,9 +100,4 @@ Each of these opt-out processes does the following:
- Forces the anonymous statistics script to exit immediately.
- Stops the PostHog JavaScript snippet, which remains on the dashboard, from firing and sending any data to the Netdata PostHog.
-## Migration from Google Analytics and Google Tag Manager.
-
-Prior to v1.29.4 we used Google Analytics to capture this information. This led to discomfort with some of our users in sending any product usage data to a third party like Google. It was also not even that useful in terms of generating the insights we needed to help catch bugs early and find opportunities for product improvement as Google Analytics does not allow its users access to the raw underlying data without paying a significant amount of money which would be infeasible for a project like Netdata.
-
-While we migrate fully away from Google Analytics to PostHog there maybe be a small period of time where we run both in parallel before we remove all Google Analytics related code. This is to ensure we can fully test and validate the Netdata PostHog implementation before fully defaulting to it.
diff --git a/docs/category-overview-pages/developers-overview.md b/docs/category-overview-pages/developers-overview.md
index 261d05d333..93a38951f5 100644
--- a/docs/category-overview-pages/developers-overview.md
+++ b/docs/category-overview-pages/developers-overview.md
@@ -4,7 +4,7 @@ sidebar_label: "Developers"
custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/category-overview-pages/developers-overview.md"
learn_status: "Published"
learn_rel_path: "Developers"
-sidebar_position: 60
+sidebar_position: 100
-->
-In this category you will find information that will aid you while developing with Netdata. \ No newline at end of file
+In this category you will find information that will aid you while developing with Netdata.
diff --git a/docs/category-overview-pages/integrations-overview.md b/docs/category-overview-pages/integrations-overview.md
index f0ea6a682a..c7a0efcf46 100644
--- a/docs/category-overview-pages/integrations-overview.md
+++ b/docs/category-overview-pages/integrations-overview.md
@@ -5,6 +5,7 @@ custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/category-o
description: "Available integrations in Netdata"
learn_status: "Published"
learn_rel_path: "Integrations"
+sidebar_position: 60
-->
# Netdata Integrations
diff --git a/docs/category-overview-pages/misc-overview.md b/docs/category-overview-pages/misc-overview.md
index 624432f02d..e0c1cc0d19 100644
--- a/docs/category-overview-pages/misc-overview.md
+++ b/docs/category-overview-pages/misc-overview.md
@@ -5,6 +5,7 @@ custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/category-o
description: "Available integrations in Netdata"
learn_status: "Published"
learn_rel_path: "Miscellaneous"
+sidebar_position: 110
-->
# Miscellaneous material
diff --git a/docs/category-overview-pages/references-overview.md b/docs/category-overview-pages/references-overview.md
index 0a33aeff66..6d99f80996 100644
--- a/docs/category-overview-pages/references-overview.md
+++ b/docs/category-overview-pages/references-overview.md
@@ -4,7 +4,7 @@ sidebar_label: "References"
custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/category-overview-pages/references-overview.md"
learn_status: "Published"
learn_rel_path: "References"
-sidebar_position: 50
+sidebar_position: 70
-->
-In this category you will find reference documentation about Netdata's components and structural blocks. \ No newline at end of file
+In this category you will find reference documentation about Netdata's components and structural blocks.
diff --git a/docs/dashboard/reference-web-server.md b/docs/dashboard/reference-web-server.md
index 0090a53836..b557b13294 100644
--- a/docs/dashboard/reference-web-server.md
+++ b/docs/dashboard/reference-web-server.md
@@ -5,8 +5,7 @@ type: reference
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/dashboard/reference-web-server.md
sidebar_label: "Web server reference"
learn_status: "Published"
-learn_topic_type: "References"
-learn_rel_path: "References"
+learn_rel_path: "Configuration"
-->
# Web server reference
diff --git a/docs/metrics-storage-management/reference-streaming.md b/docs/metrics-storage-management/reference-streaming.md
index 890e22e058..d4a2f52977 100644
--- a/docs/metrics-storage-management/reference-streaming.md
+++ b/docs/metrics-storage-management/reference-streaming.md
@@ -5,8 +5,7 @@ type: "reference"
custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/metrics-storage-management/reference-streaming.md"
sidebar_label: "Streaming reference"
learn_status: "Published"
-learn_topic_type: "References"
-learn_rel_path: "References/Configuration"
+learn_rel_path: "Configuration"
-->
# Streaming reference
diff --git a/registry/README.md b/registry/README.md
index 827eea1399..0bf174e1af 100644
--- a/registry/README.md
+++ b/registry/README.md
@@ -4,8 +4,7 @@ description: "Netdata utilizes a central registry of machines/person GUIDs, URLs
custom_edit_url: "https://github.com/netdata/netdata/edit/master/registry/README.md"
sidebar_label: "Registry"
learn_status: "Published"
-learn_topic_type: "References"
-learn_rel_path: "References/Configuration"
+learn_rel_path: "Configuration"
-->
# Registry
diff --git a/streaming/README.md b/streaming/README.md
index 4e0eb801a2..1e10592b5e 100644
--- a/streaming/README.md
+++ b/streaming/README.md
@@ -4,14 +4,14 @@ description: "Replicate and mirror Netdata's metrics through real-time streaming
custom_edit_url: https://github.com/netdata/netdata/edit/master/streaming/README.md
sidebar_label: "Streaming and replication"
learn_status: "Published"
-learn_topic_type: "References"
-learn_rel_path: "References"
+learn_rel_path: "Configuration"
-->
+# Streaming and replication
Each Netdata node is able to replicate/mirror its database to another Netdata node, by streaming the collected
-metrics in real-time. This is quite different to [data archiving to third party time-series
-databases](https://github.com/netdata/netdata/blob/master/exporting/README.md).
+metrics in real-time. This is quite different to
+[data archiving to third party time-series databases](https://github.com/netdata/netdata/blob/master/exporting/README.md).
The nodes that send metrics are called **child** nodes, and the nodes that receive metrics are called **parent** nodes.
There are also **proxy** nodes, which collect metrics from a child and sends it to a parent.
diff --git a/web/gui/README.md b/web/gui/README.md
index d84173f2ef..eefeb6d0b3 100644
--- a/web/gui/README.md
+++ b/web/gui/README.md
@@ -4,8 +4,7 @@ description: "The local Netdata Agent dashboard is the heart of health monitorin
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/gui/README.md
sidebar_label: "Local Agent dashboard"
learn_status: "Published"
-learn_topic_type: "References"
-learn_rel_path: "References"
+learn_rel_path: "Operations"
-->
# Local Agent dashboard
diff --git a/web/server/README.md b/web/server/README.md
index 407df6c038..b3c0eee354 100644
--- a/web/server/README.md
+++ b/web/server/README.md
@@ -4,8 +4,7 @@ description: "The Netdata Agent's local static-threaded web server serves dashbo
custom_edit_url: "https://github.com/netdata/netdata/edit/master/web/server/README.md"
sidebar_label: "Web server"
learn_status: "Published"
-learn_topic_type: "References"
-learn_rel_path: "References/Configuration"
+learn_rel_path: "Configuration"
-->
# Web server