summaryrefslogtreecommitdiffstats
path: root/web
diff options
context:
space:
mode:
authorFotis Voutsas <fotis@netdata.cloud>2023-02-08 19:48:19 +0200
committerGitHub <noreply@github.com>2023-02-08 09:48:19 -0800
commit2c60f324eea8970b25283c62acabaf9ae023dbff (patch)
treec781ea9b642c5b0afd4038109a56ad876fd97af5 /web
parent3f8806b3289489979880e799a2f45f18ffd34f8e (diff)
Add markdown files in Learn (#14466)
* add metadata for learn * first batch of adding metadata to md files * second batch of adding metadata to md files * third batch of adding metadata to md files * test one sidebar_label * add missing sidebar_labels * add missing sidebar_labels to files left behind * test, ansible doc is stubborn * fix * fix * fix * don't use questionmarks in the sidebar label * don't use exclamation marks and symbols in the sidebar label * fix style guide * fixes * fixes
Diffstat (limited to 'web')
-rw-r--r--web/README.md4
-rw-r--r--web/api/badges/README.md4
-rw-r--r--web/api/exporters/README.md4
-rw-r--r--web/api/exporters/prometheus/README.md4
-rw-r--r--web/api/exporters/shell/README.md6
-rw-r--r--web/api/formatters/README.md4
-rw-r--r--web/api/formatters/csv/README.md4
-rw-r--r--web/api/formatters/json/README.md4
-rw-r--r--web/api/formatters/ssv/README.md4
-rw-r--r--web/api/formatters/value/README.md4
-rw-r--r--web/api/health/README.md4
-rw-r--r--web/api/queries/README.md4
-rw-r--r--web/api/queries/average/README.md4
-rw-r--r--web/api/queries/countif/README.md4
-rw-r--r--web/api/queries/des/README.md4
-rw-r--r--web/api/queries/incremental_sum/README.md4
-rw-r--r--web/api/queries/max/README.md4
-rw-r--r--web/api/queries/median/README.md4
-rw-r--r--web/api/queries/min/README.md4
-rw-r--r--web/api/queries/percentile/README.md4
-rw-r--r--web/api/queries/ses/README.md4
-rw-r--r--web/api/queries/stddev/README.md4
-rw-r--r--web/api/queries/sum/README.md4
-rw-r--r--web/api/queries/trimmed_mean/README.md4
-rw-r--r--web/gui/README.md16
-rw-r--r--web/gui/confluence/README.md4
-rw-r--r--web/server/static/README.md4
27 files changed, 117 insertions, 5 deletions
diff --git a/web/README.md b/web/README.md
index eae5793467..dc790af7e1 100644
--- a/web/README.md
+++ b/web/README.md
@@ -2,6 +2,10 @@
title: "Dashboards"
description: "Every Netdata Agent comes bundled with hundreds of interactive, customizable charts designed by monitoring and troubleshooting experts."
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/README.md
+sidebar_label: "Dashboards"
+learn_status: "Published"
+learn_topic_type: "References"
+learn_rel_path: "Developers/Web"
-->
# Dashboards
diff --git a/web/api/badges/README.md b/web/api/badges/README.md
index 8f6eca62a0..e40e706ebb 100644
--- a/web/api/badges/README.md
+++ b/web/api/badges/README.md
@@ -1,6 +1,10 @@
<!--
title: "Netdata badges"
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/badges/README.md
+sidebar_label: "Netdata badges"
+learn_status: "Published"
+learn_topic_type: "References"
+learn_rel_path: "Developers/Web/Api"
-->
# Netdata badges
diff --git a/web/api/exporters/README.md b/web/api/exporters/README.md
index 1d517a91e4..4be5676910 100644
--- a/web/api/exporters/README.md
+++ b/web/api/exporters/README.md
@@ -1,6 +1,10 @@
<!--
title: "Exporters"
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/exporters/README.md
+sidebar_label: "Exporters"
+learn_status: "Published"
+learn_topic_type: "References"
+learn_rel_path: "Developers/Web/Api"
-->
# Exporters
diff --git a/web/api/exporters/prometheus/README.md b/web/api/exporters/prometheus/README.md
index 1ff86f4e0c..5e0f98c16b 100644
--- a/web/api/exporters/prometheus/README.md
+++ b/web/api/exporters/prometheus/README.md
@@ -1,6 +1,10 @@
<!--
title: "Prometheus exporter"
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/exporters/prometheus/README.md
+sidebar_label: "Prometheus exporter"
+learn_status: "Published"
+learn_topic_type: "References"
+learn_rel_path: "Developers/Web/Api/Exporters"
-->
# Prometheus exporter
diff --git a/web/api/exporters/shell/README.md b/web/api/exporters/shell/README.md
index a41326c9d2..49c32d8f10 100644
--- a/web/api/exporters/shell/README.md
+++ b/web/api/exporters/shell/README.md
@@ -1,6 +1,10 @@
<!--
-title: "shell exporter"
+title: "Shell exporter"
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/exporters/shell/README.md
+sidebar_label: "Shell exporter"
+learn_status: "Published"
+learn_topic_type: "References"
+learn_rel_path: "Developers/Web/Api/Exporters"
-->
# shell exporter
diff --git a/web/api/formatters/README.md b/web/api/formatters/README.md
index 4c281f0644..ddc70d90fb 100644
--- a/web/api/formatters/README.md
+++ b/web/api/formatters/README.md
@@ -1,6 +1,10 @@
<!--
title: "Query formatting"
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/formatters/README.md
+sidebar_label: "Query formatting"
+learn_status: "Published"
+learn_topic_type: "References"
+learn_rel_path: "Developers/Web/Api/Formatters"
-->
# Query formatting
diff --git a/web/api/formatters/csv/README.md b/web/api/formatters/csv/README.md
index fc5ffec1b8..4585710b4b 100644
--- a/web/api/formatters/csv/README.md
+++ b/web/api/formatters/csv/README.md
@@ -1,6 +1,10 @@
<!--
title: "CSV formatter"
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/formatters/csv/README.md
+sidebar_label: "CSV formatter"
+learn_status: "Published"
+learn_topic_type: "References"
+learn_rel_path: "Developers/Web/Api/Formatters"
-->
# CSV formatter
diff --git a/web/api/formatters/json/README.md b/web/api/formatters/json/README.md
index 75f729adab..bc70aec029 100644
--- a/web/api/formatters/json/README.md
+++ b/web/api/formatters/json/README.md
@@ -1,6 +1,10 @@
<!--
title: "JSON formatter"
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/formatters/json/README.md
+sidebar_label: "JSON formatter"
+learn_status: "Published"
+learn_topic_type: "References"
+learn_rel_path: "Developers/Web/Api/Formatters"
-->
# JSON formatter
diff --git a/web/api/formatters/ssv/README.md b/web/api/formatters/ssv/README.md
index 4ca2a64caa..434d567212 100644
--- a/web/api/formatters/ssv/README.md
+++ b/web/api/formatters/ssv/README.md
@@ -1,6 +1,10 @@
<!--
title: "SSV formatter"
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/formatters/ssv/README.md
+sidebar_label: "SSV formatter"
+learn_status: "Published"
+learn_topic_type: "References"
+learn_rel_path: "Developers/Web/Api/Formatters"
-->
# SSV formatter
diff --git a/web/api/formatters/value/README.md b/web/api/formatters/value/README.md
index 5b75ded7cf..5631d8207a 100644
--- a/web/api/formatters/value/README.md
+++ b/web/api/formatters/value/README.md
@@ -1,6 +1,10 @@
<!--
title: "Value formatter"
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/formatters/value/README.md
+sidebar_label: "Value formatter"
+learn_status: "Published"
+learn_topic_type: "References"
+learn_rel_path: "Developers/Web/Api/Formatters"
-->
# Value formatter
diff --git a/web/api/health/README.md b/web/api/health/README.md
index bfdd0ac682..dd46854a1b 100644
--- a/web/api/health/README.md
+++ b/web/api/health/README.md
@@ -2,6 +2,10 @@
title: "Health API Calls"
date: 2020-04-27
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/health/README.md
+sidebar_label: "Health API Calls"
+learn_status: "Published"
+learn_topic_type: "References"
+learn_rel_path: "Developers/Web/Api"
-->
# Health API Calls
diff --git a/web/api/queries/README.md b/web/api/queries/README.md
index 2a17ac7840..5ad0a7c99b 100644
--- a/web/api/queries/README.md
+++ b/web/api/queries/README.md
@@ -1,6 +1,10 @@
<!--
title: "Database Queries"
+sidebar_label: "Database Queries"
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/queries/README.md
+learn_status: "Published"
+learn_topic_type: "References"
+learn_rel_path: "Developers/Web/Api/Queries"
-->
# Database Queries
diff --git a/web/api/queries/average/README.md b/web/api/queries/average/README.md
index b8d4ba7e76..c9aa402cba 100644
--- a/web/api/queries/average/README.md
+++ b/web/api/queries/average/README.md
@@ -1,6 +1,10 @@
<!--
title: "Average or Mean"
+sidebar_label: "Average or Mean"
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/queries/average/README.md
+learn_status: "Published"
+learn_topic_type: "References"
+learn_rel_path: "Developers/Web/Api/Queries"
-->
# Average or Mean
diff --git a/web/api/queries/countif/README.md b/web/api/queries/countif/README.md
index 200a4c9edb..37b3f64232 100644
--- a/web/api/queries/countif/README.md
+++ b/web/api/queries/countif/README.md
@@ -1,6 +1,10 @@
<!--
title: "CountIf"
+sidebar_label: "CountIf"
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/queries/countif/README.md
+learn_status: "Published"
+learn_topic_type: "References"
+learn_rel_path: "Developers/Web/Api/Queries"
-->
# CountIf
diff --git a/web/api/queries/des/README.md b/web/api/queries/des/README.md
index 33c5f1a0cc..b12751a404 100644
--- a/web/api/queries/des/README.md
+++ b/web/api/queries/des/README.md
@@ -1,6 +1,10 @@
<!--
title: "double exponential smoothing"
+sidebar_label: "double exponential smoothing"
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/queries/des/README.md
+learn_status: "Published"
+learn_topic_type: "References"
+learn_rel_path: "Developers/Web/Api/Queries"
-->
# double exponential smoothing
diff --git a/web/api/queries/incremental_sum/README.md b/web/api/queries/incremental_sum/README.md
index 44301172e3..9b89f3188c 100644
--- a/web/api/queries/incremental_sum/README.md
+++ b/web/api/queries/incremental_sum/README.md
@@ -1,6 +1,10 @@
<!--
title: "Incremental Sum (`incremental_sum`)"
+sidebar_label: "Incremental Sum (`incremental_sum`)"
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/queries/incremental_sum/README.md
+learn_status: "Published"
+learn_topic_type: "References"
+learn_rel_path: "Developers/Web/Api/Queries"
-->
# Incremental Sum (`incremental_sum`)
diff --git a/web/api/queries/max/README.md b/web/api/queries/max/README.md
index 48da7cf087..82749c4abb 100644
--- a/web/api/queries/max/README.md
+++ b/web/api/queries/max/README.md
@@ -1,6 +1,10 @@
<!--
title: "Max"
+sidebar_label: "Max"
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/queries/max/README.md
+learn_status: "Published"
+learn_topic_type: "References"
+learn_rel_path: "Developers/Web/Api/Queries"
-->
# Max
diff --git a/web/api/queries/median/README.md b/web/api/queries/median/README.md
index 5600284c22..15549b3b50 100644
--- a/web/api/queries/median/README.md
+++ b/web/api/queries/median/README.md
@@ -1,7 +1,11 @@
<!--
title: "Median"
+sidebar_label: "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
+learn_status: "Published"
+learn_topic_type: "References"
+learn_rel_path: "Developers/Web/Api/Queries"
-->
# Median
diff --git a/web/api/queries/min/README.md b/web/api/queries/min/README.md
index 495523c047..cf63aaa010 100644
--- a/web/api/queries/min/README.md
+++ b/web/api/queries/min/README.md
@@ -1,6 +1,10 @@
<!--
title: "Min"
+sidebar_label: "Min"
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/queries/min/README.md
+learn_status: "Published"
+learn_topic_type: "References"
+learn_rel_path: "Developers/Web/Api/Queries"
-->
# Min
diff --git a/web/api/queries/percentile/README.md b/web/api/queries/percentile/README.md
index 70afc74200..19ec81ed6e 100644
--- a/web/api/queries/percentile/README.md
+++ b/web/api/queries/percentile/README.md
@@ -1,7 +1,11 @@
<!--
title: "Percentile"
+sidebar_label: "Percentile"
description: "Use percentile in API queries and health entities to find the 'percentile' 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/percentile/README.md
+learn_status: "Published"
+learn_topic_type: "References"
+learn_rel_path: "Developers/Web/Api/Queries"
-->
# Percentile
diff --git a/web/api/queries/ses/README.md b/web/api/queries/ses/README.md
index b835b8120b..56634d36ec 100644
--- a/web/api/queries/ses/README.md
+++ b/web/api/queries/ses/README.md
@@ -1,6 +1,10 @@
<!--
title: "Single (or Simple) Exponential Smoothing (`ses`)"
+sidebar_label: "Single (or Simple) Exponential Smoothing (`ses`)"
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/queries/ses/README.md
+learn_status: "Published"
+learn_topic_type: "References"
+learn_rel_path: "Developers/Web/Api/Queries"
-->
# Single (or Simple) Exponential Smoothing (`ses`)
diff --git a/web/api/queries/stddev/README.md b/web/api/queries/stddev/README.md
index 2fca47d5e4..f0586a0623 100644
--- a/web/api/queries/stddev/README.md
+++ b/web/api/queries/stddev/README.md
@@ -1,6 +1,10 @@
<!--
title: "standard deviation (`stddev`)"
+sidebar_label: "standard deviation (`stddev`)"
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/queries/stddev/README.md
+learn_status: "Published"
+learn_topic_type: "References"
+learn_rel_path: "Developers/Web/Api/Queries"
-->
# standard deviation (`stddev`)
diff --git a/web/api/queries/sum/README.md b/web/api/queries/sum/README.md
index d4465bd826..62e18acabc 100644
--- a/web/api/queries/sum/README.md
+++ b/web/api/queries/sum/README.md
@@ -1,6 +1,10 @@
<!--
title: "Sum"
+sidebar_label: "Sum"
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/queries/sum/README.md
+learn_status: "Published"
+learn_topic_type: "References"
+learn_rel_path: "Developers/Web/Api/Queries"
-->
# Sum
diff --git a/web/api/queries/trimmed_mean/README.md b/web/api/queries/trimmed_mean/README.md
index 71cdb85dbb..08a32b83be 100644
--- a/web/api/queries/trimmed_mean/README.md
+++ b/web/api/queries/trimmed_mean/README.md
@@ -1,7 +1,11 @@
<!--
title: "Trimmed Mean"
+sidebar_label: "Trimmed Mean"
description: "Use trimmed-mean in API queries and health entities to find the average 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/trimmed_mean/README.md
+learn_status: "Published"
+learn_topic_type: "References"
+learn_rel_path: "Developers/Web/Api/Queries"
-->
# Trimmed Mean
diff --git a/web/gui/README.md b/web/gui/README.md
index fbd7da4df9..e50e292317 100644
--- a/web/gui/README.md
+++ b/web/gui/README.md
@@ -2,6 +2,10 @@
title: "Local Agent dashboard"
description: "The local Netdata Agent dashboard is the heart of health monitoring and performance troubleshooting, with hundreds of real-time charts."
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"
-->
# Local Agent dashboard
@@ -28,10 +32,14 @@ behind an [Nginx proxy](https://github.com/netdata/netdata/blob/master/docs/Runn
Beyond charts, the local dashboard can be broken down into three key areas:
-1. [**Sections**](#sections)
-2. [**Time & date picker**](#time--date-picker)
-3. [**Metrics menus/submenus**](#metrics-menus)
-4. [**Netdata Cloud menus: Spaces, War Rooms, and Visited nodes)**](#cloud-menus-spaces-war-rooms-and-visited-nodes)
+- [Local Agent dashboard](#local-agent-dashboard)
+ - [Navigating the local dashboard](#navigating-the-local-dashboard)
+ - [Sections](#sections)
+ - [Time \& date picker](#time--date-picker)
+ - [Metrics menus](#metrics-menus)
+ - [Cloud menus (Spaces, War Rooms, and Visited nodes)](#cloud-menus-spaces-war-rooms-and-visited-nodes)
+ - [Customizing the local dashboard](#customizing-the-local-dashboard)
+ - [Custom dashboards](#custom-dashboards)
![Annotated screenshot of the local Agent
dashboard](https://user-images.githubusercontent.com/1153921/101509403-f7e59400-3935-11eb-9abd-cbecfa3ee49a.png)
diff --git a/web/gui/confluence/README.md b/web/gui/confluence/README.md
index 9e7b8025f4..219a48ccca 100644
--- a/web/gui/confluence/README.md
+++ b/web/gui/confluence/README.md
@@ -1,6 +1,10 @@
<!--
title: "Atlassian Confluence dashboards"
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/gui/confluence/README.md
+sidebar_label: "Atlassian Confluence dashboards"
+learn_status: "Published"
+learn_topic_type: "Tasks"
+learn_rel_path: "Developers/Web"
-->
# Atlassian Confluence dashboards
diff --git a/web/server/static/README.md b/web/server/static/README.md
index 6a83b70db4..c4e5c4c18c 100644
--- a/web/server/static/README.md
+++ b/web/server/static/README.md
@@ -2,6 +2,10 @@
title: "`static-threaded` web server"
description: "The Netdata Agent's static-threaded web server spawns a fixed number 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
+sidebar_label: "`static-threaded` web server"
+learn_status: "Published"
+learn_topic_type: "Tasks"
+learn_rel_path: "Developers/Web"
-->
# `static-threaded` web server