summaryrefslogtreecommitdiffstats
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
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
-rw-r--r--build_external/README.md5
-rw-r--r--collectors/python.d.plugin/pandas/README.md6
-rw-r--r--contrib/README.md4
-rw-r--r--contribution-guidelines.md16
-rw-r--r--database/ram/README.md4
-rw-r--r--docs/Add-more-charts-to-netdata.md4
-rw-r--r--docs/Demo-Sites.md4
-rw-r--r--docs/Donations-netdata-has-received.md4
-rw-r--r--docs/README.md4
-rw-r--r--docs/a-github-star-is-important.md4
-rw-r--r--docs/agent-cloud.md4
-rw-r--r--docs/anonymous-statistics.md4
-rw-r--r--docs/cloud/beta-architecture/new-architecture.md4
-rw-r--r--docs/cloud/cloud.mdx1
-rw-r--r--docs/contributing/contributing-documentation.md4
-rw-r--r--docs/contributing/style-guide.md21
-rw-r--r--docs/dashboard/reference-web-server.mdx4
-rw-r--r--docs/guides/collect-apache-nginx-web-logs.md4
-rw-r--r--docs/guides/collect-unbound-metrics.md4
-rw-r--r--docs/guides/configure/performance.md6
-rw-r--r--docs/guides/export/export-netdata-metrics-graphite.md6
-rw-r--r--docs/guides/longer-metrics-storage.md4
-rw-r--r--docs/guides/monitor-cockroachdb.md11
-rw-r--r--docs/guides/monitor-hadoop-cluster.md4
-rw-r--r--docs/guides/monitor/anomaly-detection-python.md4
-rw-r--r--docs/guides/monitor/anomaly-detection.md4
-rw-r--r--docs/guides/monitor/dimension-templates.md4
-rw-r--r--docs/guides/monitor/kubernetes-k8s-netdata.md4
-rw-r--r--docs/guides/monitor/lamp-stack.md4
-rw-r--r--docs/guides/monitor/pi-hole-raspberry-pi.md4
-rw-r--r--docs/guides/monitor/process.md4
-rw-r--r--docs/guides/monitor/raspberry-pi-anomaly-detection.md4
-rw-r--r--docs/guides/monitor/statsd.md4
-rw-r--r--docs/guides/monitor/stop-notifications-alarms.md4
-rw-r--r--docs/guides/monitor/visualize-monitor-anomalies.md4
-rw-r--r--docs/guides/python-collector.md4
-rw-r--r--docs/guides/step-by-step/step-00.md4
-rw-r--r--docs/guides/step-by-step/step-01.md17
-rw-r--r--docs/guides/step-by-step/step-02.md21
-rw-r--r--docs/guides/step-by-step/step-03.md4
-rw-r--r--docs/guides/step-by-step/step-04.md15
-rw-r--r--docs/guides/step-by-step/step-05.md16
-rw-r--r--docs/guides/step-by-step/step-06.md13
-rw-r--r--docs/guides/step-by-step/step-07.md13
-rw-r--r--docs/guides/step-by-step/step-08.md22
-rw-r--r--docs/guides/step-by-step/step-09.md13
-rw-r--r--docs/guides/step-by-step/step-10.md19
-rw-r--r--docs/guides/step-by-step/step-99.md6
-rw-r--r--docs/guides/troubleshoot/monitor-debug-applications-ebpf.md4
-rw-r--r--docs/guides/troubleshoot/troubleshooting-agent-with-cloud-connection.md16
-rw-r--r--docs/guides/using-host-labels.md4
-rw-r--r--docs/netdata-for-IoT.md4
-rw-r--r--docs/netdata-security.md29
-rw-r--r--docs/overview/netdata-monitoring-stack.md4
-rw-r--r--docs/overview/what-is-netdata.md4
-rw-r--r--docs/overview/why-netdata.md4
-rw-r--r--docs/quickstart/infrastructure.md5
-rw-r--r--docs/quickstart/single-node.md5
-rw-r--r--docs/visualize/create-dashboards.md4
-rw-r--r--docs/visualize/interact-dashboards-charts.md4
-rw-r--r--docs/visualize/overview-infrastructure.md4
-rw-r--r--docs/why-netdata/1s-granularity.md4
-rw-r--r--docs/why-netdata/README.md4
-rw-r--r--docs/why-netdata/immediate-results.md4
-rw-r--r--docs/why-netdata/meaningful-presentation.md4
-rw-r--r--docs/why-netdata/unlimited-metrics.md4
-rw-r--r--libnetdata/clocks/README.md9
-rw-r--r--libnetdata/onewayalloc/README.md2
-rw-r--r--libnetdata/socket/README.md7
-rw-r--r--libnetdata/worker_utilization/README.md2
-rw-r--r--packaging/building-native-packages-locally.md6
-rw-r--r--packaging/installer/methods/ansible.md2
-rw-r--r--packaging/installer/methods/cloud-providers.md14
-rw-r--r--packaging/installer/methods/freebsd.md4
-rw-r--r--packaging/installer/methods/freenas.md4
-rw-r--r--packaging/installer/methods/pfsense.md4
-rw-r--r--packaging/installer/methods/synology.md4
-rw-r--r--packaging/maintainers/README.md4
-rw-r--r--packaging/makeself/README.md4
-rw-r--r--parser/README.md4
-rw-r--r--streaming/README.md4
-rw-r--r--tests/health_mgmtapi/README.md4
-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
109 files changed, 558 insertions, 100 deletions
diff --git a/build_external/README.md b/build_external/README.md
index d68e4d0f10..76e9cd48ec 100644
--- a/build_external/README.md
+++ b/build_external/README.md
@@ -1,7 +1,10 @@
<!--
title: "External build-system"
-date: 2020-03-31
custom_edit_url: https://github.com/netdata/netdata/edit/master/build_external/README.md
+sidebar_label: "External build-system"
+learn_status: "Published"
+learn_topic_type: "References"
+learn_rel_path: "Developers"
-->
# External build-system
diff --git a/collectors/python.d.plugin/pandas/README.md b/collectors/python.d.plugin/pandas/README.md
index 141549478d..36430060af 100644
--- a/collectors/python.d.plugin/pandas/README.md
+++ b/collectors/python.d.plugin/pandas/README.md
@@ -1,6 +1,10 @@
<!--
-title: "Pandas"
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/pandas/README.md
+title: "Pandas Netdata Collector"
+sidebar_label: "Pandas Netdata Collector"
+learn_status: "Published"
+learn_topic_type: "References"
+learn_rel_path: "References/Collectors references"
-->
# Pandas Netdata Collector
diff --git a/contrib/README.md b/contrib/README.md
index 36abd3b102..2a5e640503 100644
--- a/contrib/README.md
+++ b/contrib/README.md
@@ -1,6 +1,10 @@
<!--
title: "Netdata contrib"
custom_edit_url: https://github.com/netdata/netdata/edit/master/contrib/README.md
+sidebar_label: "Netdata contrib"
+learn_status: "Published"
+learn_topic_type: "References"
+learn_rel_path: "Developers"
-->
# Netdata contrib
diff --git a/contribution-guidelines.md b/contribution-guidelines.md
index f659298035..5828bfc2a6 100644
--- a/contribution-guidelines.md
+++ b/contribution-guidelines.md
@@ -685,21 +685,11 @@ Some documents, like the Ansible guide and others in the `/docs/guides` folder,
this case, replace `/docs` with `/img/seo`, and then rebuild the remainder of the path to the document in question. End
the path with `.png`. A member of the Netdata team will assist in creating the image when publishing the content.
-For example, here is the frontmatter for the guide about [deploying the Netdata Agent with
-Ansible](https://github.com/netdata/netdata/blob/master/docs/guides/deploy/ansible.md).
+For example, here is the frontmatter for the guide
+about [deploying the Netdata Agent with Ansible](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/ansible.md).
-```markdown
-<!--
-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."
-image: /img/seo/guides/deploy/ansible.png
-custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/deploy/ansible.md
--->
-
-# Deploy Netdata with Ansible
+<img width="751" alt="image" src="https://user-images.githubusercontent.com/43294513/217607958-ef0f270d-7947-4d91-a9a5-56b17b4255ee.png">
-...
-```
Questions about frontmatter in documentation? [Ask on our community
forum](https://community.netdata.cloud/c/blog-posts-and-articles/6).
diff --git a/database/ram/README.md b/database/ram/README.md
index 73562f0fff..b9f0531067 100644
--- a/database/ram/README.md
+++ b/database/ram/README.md
@@ -2,6 +2,10 @@
title: "RAM database modes"
description: "Netdata's RAM database modes."
custom_edit_url: https://github.com/netdata/netdata/edit/master/database/ram/README.md
+sidebar_label: "RAM database modes"
+learn_status: "Published"
+learn_topic_type: "References"
+learn_rel_path: "Developers/Database"
-->
# RAM modes \ No newline at end of file
diff --git a/docs/Add-more-charts-to-netdata.md b/docs/Add-more-charts-to-netdata.md
index 35a89fba07..b1530431e8 100644
--- a/docs/Add-more-charts-to-netdata.md
+++ b/docs/Add-more-charts-to-netdata.md
@@ -1,6 +1,10 @@
<!--
title: "Add more charts to Netdata"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Add-more-charts-to-netdata.md
+sidebar_label: "Add more charts to Netdata"
+learn_status: "Published"
+learn_topic_type: "References"
+learn_rel_path: "Possible old, not wanted documents"
-->
# Add more charts to Netdata
diff --git a/docs/Demo-Sites.md b/docs/Demo-Sites.md
index 5c4d1018fd..95448f9439 100644
--- a/docs/Demo-Sites.md
+++ b/docs/Demo-Sites.md
@@ -2,6 +2,10 @@
title: "Demo sites"
date: 2020-03-26
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Demo-Sites.md
+sidebar_label: "Demo sites"
+learn_status: "Published"
+learn_topic_type: "References"
+learn_rel_path: "Possible old, not wanted documents"
-->
# Demo sites
diff --git a/docs/Donations-netdata-has-received.md b/docs/Donations-netdata-has-received.md
index a8623c5dbf..c7fd6f21aa 100644
--- a/docs/Donations-netdata-has-received.md
+++ b/docs/Donations-netdata-has-received.md
@@ -1,6 +1,10 @@
<!--
title: "Donations"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Donations-netdata-has-received.md
+sidebar_label: "Donations"
+learn_status: "Published"
+learn_topic_type: "References"
+learn_rel_path: "Possible old, not wanted documents"
-->
# Donations
diff --git a/docs/README.md b/docs/README.md
index e3b9156176..8b59289170 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -1,6 +1,10 @@
<!--
title: "Read documentation on <https://learn.netdata.cloud>"
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/README.md
+sidebar_label: "Old welcome to Documentation message doc"
+learn_status: "Published"
+learn_topic_type: "References"
+learn_rel_path: "Possible old, not wanted documents"
-->
# Read documentation on <https://learn.netdata.cloud>
diff --git a/do