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 ---> +<img width="751" alt="image" src="https://user-images.githubusercontent.com/43294513/217607958-ef0f270d-7947-4d91-a9a5-56b17b4255ee.png"> -# Deploy Netdata with Ansible - -... -``` 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/docs/a-github-star-is-important.md b/docs/a-github-star-is-important.md index 22659ea6f5..754b317f9a 100644 --- a/docs/a-github-star-is-important.md +++ b/docs/a-github-star-is-important.md @@ -1,6 +1,10 @@ <!-- title: "A GitHub star is important" custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/a-github-star-is-important.md +sidebar_label: "A GitHub star is important" +learn_status: "Published" +learn_topic_type: "References" +learn_rel_path: "Misc" --> # A GitHub star is important diff --git a/docs/agent-cloud.md b/docs/agent-cloud.md index b5b9966175..7a9871e81f 100644 --- a/docs/agent-cloud.md +++ b/docs/agent-cloud.md @@ -2,6 +2,10 @@ title: "Use the Agent with Netdata Cloud" date: 2020-05-04 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/agent-cloud.md +sidebar_label: "Use the Agent with Netdata Cloud" +learn_status: "Published" +learn_topic_type: "References" +learn_rel_path: "Possible old, not wanted documents" --> # Use the Agent with Netdata Cloud diff --git a/docs/anonymous-statistics.md b/docs/anonymous-statistics.md index 13eb465c64..950f44e12f 100644 --- a/docs/anonymous-statistics.md +++ b/docs/anonymous-statistics.md @@ -1,6 +1,10 @@ <!-- title: "Anonymous statistics" custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/anonymous-statistics.md +sidebar_label: "Anonymous statistics" +learn_status: "Published" +learn_topic_type: "References" +learn_rel_path: "References" --> # Anonymous statistics diff --git a/docs/cloud/beta-architecture/new-architecture.md b/docs/cloud/beta-architecture/new-architecture.md index 0741f1cbe3..14ef74e072 100644 --- a/docs/cloud/beta-architecture/new-architecture.md +++ b/docs/cloud/beta-architecture/new-architecture.md @@ -2,6 +2,10 @@ title: "Test the New Cloud Architecture" description: "Would you like to be the first to try our new architecture and provide feedback? If so, this guide will help you sign up for our beta testing group." custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/beta-architecture/new-architecture.md" +sidebar_label: "Test the New Cloud Architecture" +learn_status: "Published" +learn_topic_type: "References" +learn_rel_path: "Possible old, not wanted documents" --> To enhance the stability and reliability of Netdata Cloud, we did extensive work on our backend, and we would like to give you the opportunity diff --git a/docs/cloud/cloud.mdx b/docs/cloud/cloud.mdx index 783d22a397..056d9128c1 100644 --- a/docs/cloud/cloud.mdx +++ b/docs/cloud/cloud.mdx @@ -2,6 +2,7 @@ title: "Netdata Cloud" description: "Netdata Cloud is real-time visibility for entire infrastructures. View key metrics, insightful charts, and active alarms from all your nodes." custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/cloud/cloud.mdx" +sidebar_label: "Netdata Cloud" learn_status: "Published" learn_topic_type: "Concepts" learn_rel_path: "Getting Started" diff --git a/docs/contributing/contributing-documentation.md b/docs/contributing/contributing-documentation.md index da28272b45..aa3d8f69b1 100644 --- a/docs/contributing/contributing-documentation.md +++ b/docs/contributing/contributing-documentation.md @@ -2,6 +2,10 @@ title: "Contributing to documentation" description: "Want to contribute to Netdata's documentation? This guide will set you up with the tools to help others learn about health and performance monitoring." custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/contributing/contributing-documentation.md +sidebar_label: "Contributing to documentation" +learn_status: "Published" +learn_topic_type: "References" +learn_rel_path: "Possible old, not wanted documents" --> # Contributing to documentation diff --git a/docs/contributing/style-guide.md b/docs/contributing/style-guide.md index 7d1b86478e..ce238c5c92 100644 --- a/docs/contributing/style-guide.md +++ b/docs/contributing/style-guide.md @@ -2,6 +2,10 @@ title: "Netdata style guide" description: "The Netdata style guide establishes editorial guidelines for all of Netdata's writing, including documentation, blog posts, in-product UX copy, and more." custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/contributing/style-guide.md +sidebar_label: "Netdata style guide" +learn_status: "Published" +learn_topic_type: "References" +learn_rel_path: "Contribute" --> # Netdata style guide @@ -374,20 +378,9 @@ this case, replace `/docs` with `/img/seo`, and then rebuild the remainder of th 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). +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). @@ -401,7 +394,7 @@ Links should always reference the full path to the document, beginning at the ro For example, if you want to link to our node configuration document, link to `https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md`. To reference -the guide for deploying the Netdata Agent with Ansible, link to `/docs/guides/deploy/ansible.md`. +the guide for deploying the Netdata Agent with Ansible, link to `/packaging/installer/methods/ansible.md`. ### References to UI elements diff --git a/docs/dashboard/reference-web-server.mdx b/docs/dashboard/reference-web-server.mdx index d3b4429fc4..09817c0a44 100644 --- a/docs/dashboard/reference-web-server.mdx +++ b/docs/dashboard/reference-web-server.mdx @@ -3,6 +3,10 @@ title: "Web server reference" description: "The Netdata Agent's local static-threaded web server serves dashboards and real-time visualizations with security and DDoS protection." type: reference custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/dashboard/reference-web-server.mdx +sidebar_label: "Web server reference" +learn_status: "Published" +learn_topic_type: "References" +learn_rel_path: "References" --> # Web server reference diff --git a/docs/guides/collect-apache-nginx-web-logs.md b/docs/guides/collect-apache-nginx-web-logs.md index b4a5254715..87137332c2 100644 --- a/docs/guides/collect-apache-nginx-web-logs.md +++ b/docs/guides/collect-apache-nginx-web-logs.md @@ -1,6 +1,10 @@ <!-- title: "Monitor Nginx or Apache web server log files with Netdata" +sidebar_label: "Monitor Nginx or Apache web server log files with Netdata" custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/collect-apache-nginx-web-logs.md +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Guides" --> # Monitor Nginx or Apache web server log files with Netdata diff --git a/docs/guides/collect-unbound-metrics.md b/docs/guides/collect-unbound-metrics.md index 5400fd8334..e033af5cb5 100644 --- a/docs/guides/collect-unbound-metrics.md +++ b/docs/guides/collect-unbound-metrics.md @@ -1,7 +1,11 @@ <!-- title: "Monitor Unbound DNS servers with Netdata" +sidebar_label: "Monitor Unbound DNS servers with Netdata" date: 2020-03-31 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/collect-unbound-metrics.md +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Guides" --> # Monitor Unbound DNS servers with Netdata diff --git a/docs/guides/configure/performance.md b/docs/guides/configure/performance.md index 256d6e854d..6cde1f2b00 100644 --- a/docs/guides/configure/performance.md +++ b/docs/guides/configure/performance.md @@ -1,8 +1,12 @@ <!-- -title: How to optimize the Netdata Agent's performance +title: "How to optimize the Netdata Agent's performance" +sidebar_label: "How to optimize the Netdata Agent's performance" description: "While the Netdata Agent is designed to monitor a system with only 1% CPU, you can optimize its performance for low-resource systems." image: /img/seo/guides/configure/performance.png custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/configure/performance.md +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Guides" --> # How to optimize the Netdata Agent's performance diff --git a/docs/guides/export/export-netdata-metrics-graphite.md b/docs/guides/export/export-netdata-metrics-graphite.md index 985ba22415..35f8f5ca1f 100644 --- a/docs/guides/export/export-netdata-metrics-graphite.md +++ b/docs/guides/export/export-netdata-metrics-graphite.md @@ -1,7 +1,11 @@ <!-- -title: Export and visualize Netdata metrics in Graphite +title: "Export and visualize Netdata metrics in Graphite" +sidebar_label: "Export and visualize Netdata metrics in Graphite" description: "Use Netdata to collect and export thousands of metrics to Graphite for long-term storage or further analysis." image: /img/seo/guides/export/export-netdata-metrics-graphite.png +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Guides" --> import { OneLineInstallWget } from '@site/src/components/OneLineInstall/' diff --git a/docs/guides/longer-metrics-storage.md b/docs/guides/longer-metrics-storage.md index 8ccd9585fa..bea3b8a51f 100644 --- a/docs/guides/longer-metrics-storage.md +++ b/docs/guides/longer-metrics-storage.md @@ -1,7 +1,11 @@ <!-- title: "Netdata Longer Metrics Retention" +sidebar_label: "Netdata Longer Metrics Retention" description: "" custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/longer-metrics-storage.md +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Guides" --> # Netdata Longer Metrics Retention diff --git a/docs/guides/monitor-cockroachdb.md b/docs/guides/monitor-cockroachdb.md index 3c6e1b2cf6..afd133e855 100644 --- a/docs/guides/monitor-cockroachdb.md +++ b/docs/guides/monitor-cockroachdb.md @@ -1,6 +1,10 @@ <!-- title: "Monitor CockroachDB metrics with Netdata" +sidebar_label: "Monitor CockroachDB metrics with Netdata" custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/monitor-cockroachdb.md +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Guides" --> # Monitor CockroachDB metrics with Netdata @@ -20,9 +24,12 @@ Let's dive in and walk through the process of monitoring CockroachDB metrics wit ## What's in this guide -- [Configure the CockroachDB collector](#configure-the-cockroachdb-collector) +- [Monitor CockroachDB metrics with Netdata](#monitor-cockroachdb-metrics-with-netdata) + - [What's in this guide](#whats-in-this-guide) + - [Configure the CockroachDB collector](#configure-the-cockroachdb-collector) - [Manual setup for a local CockroachDB database](#manual-setup-for-a-local-cockroachdb-database) -- [Tweak CockroachDB alarms](#tweak-cockroachdb-alarms) + - [Tweak CockroachDB alarms](#tweak-cockroachdb-alarms) + - [What's next?](#whats-next) ## Configure the CockroachDB collector diff --git a/docs/guides/monitor-hadoop-cluster.md b/docs/guides/monitor-hadoop-cluster.md index cce261feec..0fb3b7c407 100644 --- a/docs/guides/monitor-hadoop-cluster.md +++ b/docs/guides/monitor-hadoop-cluster.md @@ -1,6 +1,10 @@ <!-- title: "Monitor a Hadoop cluster with Netdata" +sidebar_label: "Monitor a Hadoop cluster with Netdata" custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/monitor-hadoop-cluster.md +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Guides" --> # Monitor a Hadoop cluster with Netdata diff --git a/docs/guides/monitor/anomaly-detection-python.md b/docs/guides/monitor/anomaly-detection-python.md index d6d27f4e57..81a53d8468 100644 --- a/docs/guides/monitor/anomaly-detection-python.md +++ b/docs/guides/monitor/anomaly-detection-python.md @@ -1,11 +1,15 @@ <!-- title: "Detect anomalies in systems and applications" +sidebar_label: "Detect anomalies in systems and applications" description: "Detect anomalies in any system, container, or application in your infrastructure with machine learning and the open-source Netdata Agent." image: /img/seo/guides/monitor/anomaly-detection.png author: "Joel Hans" author_title: "Editorial Director, Technical & Educational Resources" author_img: "/img/authors/joel-hans.jpg" custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/monitor/anomaly-detection-python.md +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Guides/Monitor" --> # Detect anomalies in systems and applications diff --git a/docs/guides/monitor/anomaly-detection.md b/docs/guides/monitor/anomaly-detection.md index ce819d937a..87cbb858ef 100644 --- a/docs/guides/monitor/anomaly-detection.md +++ b/docs/guides/monitor/anomaly-detection.md @@ -1,11 +1,15 @@ <!-- title: "Machine learning (ML) powered anomaly detection" +sidebar_label: "Machine learning (ML) powered anomaly detection" description: "Detect anomalies in any system, container, or application in your infrastructure with machine learning and the open-source Netdata Agent." image: /img/seo/guides/monitor/anomaly-detection.png author: "Andrew Maguire" author_title: "Analytics & ML Lead" author_img: "/img/authors/andy-maguire.jpg" custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/monitor/anomaly-detection.md +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Guides/Monitor" --> diff --git a/docs/guides/monitor/dimension-templates.md b/docs/guides/monitor/dimension-templates.md index d2795a9c60..15b27188f4 100644 --- a/docs/guides/monitor/dimension-templates.md +++ b/docs/guides/monitor/dimension-templates.md @@ -1,6 +1,10 @@ <!-- title: "Use dimension templates to create dynamic alarms" +sidebar_label: "Use dimension templates to create dynamic alarms" custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/monitor/dimension-templates.md +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Guides/Monitor" --> # Use dimension templates to create dynamic alarms diff --git a/docs/guides/monitor/kubernetes-k8s-netdata.md b/docs/guides/monitor/kubernetes-k8s-netdata.md index 5732fc96c6..a70d4a58a2 100644 --- a/docs/guides/monitor/kubernetes-k8s-netdata.md +++ b/docs/guides/monitor/kubernetes-k8s-netdata.md @@ -1,11 +1,15 @@ <!-- title: "Kubernetes monitoring with Netdata: Overview and visualizations" +sidebar_label: "Kubernetes monitoring with Netdata: Overview and visualizations" description: "Learn how to navigate Netdata's Kubernetes monitoring features for visualizing the health and performance of a Kubernetes cluster with per-second granularity." image: /img/seo/guides/monitor/kubernetes-k8s-netdata.png author: "Joel Hans" author_title: "Editorial Director, Technical & Educational Resources" author_img: "/img/authors/joel-hans.jpg" custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/monitor/kubernetes-k8s-netdata.md +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Guides/Monitor" --> # Kubernetes monitoring with Netdata: Overview and visualizations diff --git a/docs/guides/monitor/lamp-stack.md b/docs/guides/monitor/lamp-stack.md index 165888c4bf..3a50e757f4 100644 --- a/docs/guides/monitor/lamp-stack.md +++ b/docs/guides/monitor/lamp-stack.md @@ -1,11 +1,15 @@ <!-- title: "LAMP stack monitoring (Linux, Apache, MySQL, PHP) with Netdata" +sidebar_label: "LAMP stack monitoring (Linux, Apache, MySQL, PHP) with Netdata" description: "Set up robust LAMP stack monitoring (Linux, Apache, MySQL, PHP) in just a few minutes using a free, open-source monitoring tool that collects metrics every second." image: /img/seo/guides/monitor/lamp-stack.png author: "Joel Hans" author_title: "Editorial Director, Technical & Educational Resources" author_img: "/img/authors/joel-hans.jpg" custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/monitor/lamp-stack.md +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Guides/Monitor" --> import { OneLineInstallWget } from '@site/src/components/OneLineInstall/' diff --git a/docs/guides/monitor/pi-hole-raspberry-pi.md b/docs/guides/monitor/pi-hole-raspberry-pi.md index 5099d12b95..9103ce661e 100644 --- a/docs/guides/monitor/pi-hole-raspberry-pi.md +++ b/docs/guides/monitor/pi-hole-raspberry-pi.md @@ -1,8 +1,12 @@ <!-- title: "Monitor Pi-hole (and a Raspberry Pi) with Netdata" +sidebar_label: "Monitor Pi-hole (and a Raspberry Pi) with Netdata" description: "Monitor Pi-hole metrics, plus Raspberry Pi system metrics, in minutes and completely for free with Netdata's open-source monitoring agent." image: /img/seo/guides/monitor/netdata-pi-hole-raspberry-pi.png custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/monitor/pi-hole-raspberry-pi.md +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Guides/Monitor" --> import { OneLineInstallWget } from '@site/src/components/OneLineInstall/' diff --git a/docs/guides/monitor/process.md b/docs/guides/monitor/process.md index 7cc327a01c..9e07761170 100644 --- a/docs/guides/monitor/process.md +++ b/docs/guides/monitor/process.md @@ -1,8 +1,12 @@ <!-- title: Monitor any process in real-time with Netdata +sidebar_label: Monitor any process in real-time with Netdata description: "Tap into Netdata's powerful collectors, with per-second utilization metrics for every process, to troubleshoot faster and make data-informed decisions." image: /img/seo/guides/monitor/process.png custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/monitor/process.md +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Guides/Monitor" --> # Monitor any process in real-time with Netdata diff --git a/docs/guides/monitor/raspberry-pi-anomaly-detection.md b/docs/guides/monitor/raspberry-pi-anomaly-detection.md index 39a2327253..ddd2787329 100644 --- a/docs/guides/monitor/raspberry-pi-anomaly-detection.md +++ b/docs/guides/monitor/raspberry-pi-anomaly-detection.md @@ -1,11 +1,15 @@ <!-- title: "Unsupervised anomaly detection for Raspberry Pi monitoring" +sidebar_label: "Unsupervised anomaly detection for Raspberry Pi monitoring" description: "Use a low-overhead machine learning algorithm and an open-source monitoring tool to detect anomalous metrics on a Raspberry Pi." image: /img/seo/guides/monitor/raspberry-pi-anomaly-detection.png author: "Andy Maguire" author_title: "Senior Machine Learning Engineer" author_img: "/img/authors/andy-maguire.jpg" custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/monitor/raspberry-pi-anomaly-detection.md +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Guides/Monitor" --> We love IoT and edge at Netdata, we also love machine learning. Even better if we can combine the two to ease the pain diff --git a/docs/guides/monitor/statsd.md b/docs/guides/monitor/statsd.md index 848e2649ce..7eea106da7 100644 --- a/docs/guides/monitor/statsd.md +++ b/docs/guides/monitor/statsd.md @@ -1,11 +1,15 @@ <!-- title: How to use any StatsD data source with Netdata +sidebar_label: How to use any StatsD data source with Netdata description: "Learn how to monitor any custom application instrumented with StatsD with per-second metrics and fully customizable, interactive charts." image: /img/seo/guides/monitor/statsd.png author: "Odysseas Lamtzidis" author_title: "Developer Advocate" author_img: "/img/authors/odysseas-lamtzidis.jpg" custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/monitor/statsd.md +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Guides/Monitor" --> # StatsD Guide diff --git a/docs/guides/monitor/stop-notifications-alarms.md b/docs/guides/monitor/stop-notifications-alarms.md index 3c026a89bb..d54d8e8da0 100644 --- a/docs/guides/monitor/stop-notifications-alarms.md +++ b/docs/guides/monitor/stop-notifications-alarms.md @@ -1,6 +1,10 @@ <!-- title: "Stop notifications for individual alarms" +sidebar_label: "Stop notifications for individual alarms" custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/monitor/stop-notifications-alarms.md +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Guides/Monitor" --> # Stop notifications for individual alarms diff --git a/docs/guides/monitor/visualize-monitor-anomalies.md b/docs/guides/monitor/visualize-monitor-anomalies.md index da9f5ae569..20c77b849d 100644 --- a/docs/guides/monitor/visualize-monitor-anomalies.md +++ b/docs/guides/monitor/visualize-monitor-anomalies.md @@ -1,11 +1,15 @@ <!-- title: "Monitor and visualize anomalies with Netdata (part 2)" +sidebar_label: "Monitor and visualize anomalies with Netdata (part 2)" description: "Using unsupervised anomaly detection and machine learning, get notified " image: /img/seo/guides/monitor/visualize-monitor-anomalies.png author: "Joel Hans" author_title: "Editorial Director, Technical & Educational Resources" author_img: "/img/authors/joel-hans.jpg" custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/monitor/visualize-monitor-anomalies.md +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Guides/Monitor" --> Welcome to part 2 of our series of guides on using _unsupervised anomaly detection_ to detect issues with your systems, diff --git a/docs/guides/python-collector.md b/docs/guides/python-collector.md index e0e7a60417..7dcfde72f0 100644 --- a/docs/guides/python-collector.md +++ b/docs/guides/python-collector.md @@ -1,11 +1,15 @@ <!-- title: "Develop a custom data collector in Python" +sidebar_label: "Develop a custom data collector in Python" description: "Learn how write a custom data collector in Python, which you'll use to collect metrics from and monitor any application that isn't supported out of the box." image: /img/seo/guides/python-collector.png author: "Panagiotis Papaioannou" author_title: "University of Patras" author_img: "/img/authors/panagiotis-papaioannou.jpg" custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/python-collector.md +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Guides" --> # Develop a custom data collector in Python diff --git a/docs/guides/step-by-step/step-00.md b/docs/guides/step-by-step/step-00.md index 2f83ee9b48..a45f1561f2 100644 --- a/docs/guides/step-by-step/step-00.md +++ b/docs/guides/step-by-step/step-00.md @@ -1,7 +1,11 @@ <!-- title: "The step-by-step Netdata guide" +sidebar_label: "The step-by-step Netdata guide" date: 2020-03-31 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/step-by-step/step-00.md +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Guides/Step by step" --> import { OneLineInstallWget, OneLineInstallCurl } from '@site/src/components/OneLineInstall/' diff --git a/docs/guides/step-by-step/step-01.md b/docs/guides/step-by-step/step-01.md index e60bb07699..6e60200c51 100644 --- a/docs/guides/step-by-step/step-01.md +++ b/docs/guides/step-by-step/step-01.md @@ -1,6 +1,10 @@ <!-- title: "Step 1. Netdata's building blocks" +sidebar_label: "Step 1. Netdata's building blocks" custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/step-by-step/step-01.md +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Guides/Step by step" --> # Step 1. Netdata's building blocks @@ -29,9 +33,16 @@ be)](https://blog.netdata.cloud/posts/redefining-monitoring-netdata/)_. In the first step of the Netdata guide, you'll learn about: -- [Netdata's core features](#netdatas-core-features) -- [Why you should use Netdata](#why-you-should-use-netdata) -- [How Netdata has complementary systems, not competitors](#how-netdata-has-complementary-systems-not-competitors) +- [Step 1. Netdata's building blocks](#step-1-netdatas-building-blocks) + - [What you'll learn in this step](#what-youll-learn-in-this-step) + - [Netdata's core features](#netdatas-core-features) + - [Why you should use Netdata](#why-you-should-use-netdata) + - [Per-second data collection](#per-second-data-collection) + - [Unlimited metrics](#unlimited-metrics) + - [Meaningful presentation](#meaningful-presentation) + - [Immediate results](#immediate-results) + - [How Netdata has complementary systems, not competitors](#how-netdata-has-complementary-systems-not-competitors) + - [What's next?](#whats-next) Let's get started! diff --git a/docs/guides/step-by-step/step-02.md b/docs/guides/step-by-step/step-02.md index 535f3cfa3f..e23541ce86 100644 --- a/docs/guides/step-by-step/step-02.md +++ b/docs/guides/step-by-step/step-02.md @@ -1,7 +1,11 @@ <!-- title: "Step 2. Get to know Netdata's dashboard" +sidebar_label: "Step 2. Get to know Netdata's dashboard" date: 2020-05-04 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/step-by-step/step-02.md +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Guides/Step by step" --> # Step 2. Get to know Netdata's dashboard @@ -18,11 +22,18 @@ over here and dig in. In this step of the Netdata guide, you'll learn how to: -- [Visit and explore the dashboard](#visit-and-explore-the-dashboard) -- [Explore available charts using menus](#explore-available-charts-using-menus) -- [Read the descriptions accompanying charts](#read-the-descriptions-accompanying-charts) -- [Interact with charts](#interact-with-charts) -- [See raised alarms and the alarm log](#see-raised-alarms-and-the-alarm-log) +- [Step 2. Get to know Netdata's dashboard](#step-2-get-to-know-netdatas-dashboard) + - [What you'll learn in this step](#what-youll-learn-in-this-step) + - [Visit and explore the dashboard](#visit-and-explore-the-dashboard) + - [Explore available charts using menus](#explore-available-charts-using-menus) + - [Read the descriptions accompanying charts](#read-the-descriptions-accompanying-charts) + - [Understand charts, dimensions, families, and contexts](#understand-charts-dimensions-families-and-contexts) + - [Interact with charts](#interact-with-charts) + - [Pan, zoom, highlight, and reset charts](#pan-zoom-highlight-and-reset-charts) + - [Show and hide dimensions](#show-and-hide-dimensions) + - [Resize charts](#resize-charts) + - [See raised alarms and the alarm log](#see-raised-alarms-and-the-alarm-log) + - [What's next?](#whats-next) Let's get started! diff --git a/docs/guides/step-by-step/step-03.md b/docs/guides/step-by-step/step-03.md index 3204765b4a..803ef58a06 100644 --- a/docs/guides/step-by-step/step-03.md +++ b/docs/guides/step-by-step/step-03.md @@ -1,7 +1,11 @@ <!-- title: "Step 3. Monitor more than one system with Netdata" +sidebar_label: "Step 3. Monitor more than one system with Netdata" date: 2020-05-01 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/step-by-step/step-03.md +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Guides/Step by step" --> # Step 3. Monitor more than one system with Netdata diff --git a/docs/guides/step-by-step/step-04.md b/docs/guides/step-by-step/step-04.md index fcd84ce6aa..f571af444a 100644 --- a/docs/guides/step-by-step/step-04.md +++ b/docs/guides/step-by-step/step-04.md @@ -1,7 +1,11 @@ <!-- title: "Step 4. The basics of configuring Netdata" +sidebar_label: "Step 4. The basics of configuring Netdata" date: 2020-03-31 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/step-by-step/step-04.md +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Guides/Step by step" --> # Step 4. The basics of configuring Netdata @@ -17,10 +21,13 @@ Next up: configuration. We'll talk about Netdata's default configuration, and then you'll learn how to do the following: -- [Find your `netdata.conf` file](#find-your-netdataconf-file) -- [Use edit-config to open `netdata.conf`](#use-edit-config-to-open-netdataconf) -- [Navigate the structure of `netdata.conf`](#the-structure-of-netdataconf) -- [Edit your `netdata.conf` file](#edit-your-netdataconf-file) +- [Step 4. The basics of configuring Netdata](#step-4-the-basics-of-configuring-netdata) + - [What you'll learn in this step](#what-youll-learn-in-this-step) + - [Find your `netdata.conf` file](#find-your-netdataconf-file) + - [Use edit-config to open `netdata.conf`](#use-edit-config-to-open-netdataconf) + - [The structure of `netdata.conf`](#the-structure-of-netdataconf) + - [Edit your `netdata.conf` file](#edit-your-netdataconf-file) + - [What's next?](#whats-next) ## Find your `netdata.conf` file diff --git a/docs/guides/step-by-step/step-05.md b/docs/guides/step-by-step/step-05.md index 3ef498d408..9386493df2 100644 --- a/docs/guides/step-by-step/step-05.md +++ b/docs/guides/step-by-step/step-05.md @@ -1,6 +1,10 @@ <!-- title: "Step 5. Health monitoring alarms and notifications" +sidebar_label: "Step 5. Health monitoring alarms and notifications" custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/step-by-step/step-05.md +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Guides/Step by step" --> # Step 5. Health monitoring alarms and notifications @@ -20,9 +24,15 @@ Luckily, Netdata's alarm and notification system are incredibly adaptable to you We'll talk about Netdata's default configuration, and then you'll learn how to do the following: -- [Tune Netdata's pre-configured alarms](#tune-netdatas-pre-configured-alarms) -- [Write your first health entity](#write-your-first-health-entity) -- [Enable Netdata's notification systems](#enable-netdatas-notification-systems) +- [Step 5. Health monitoring alarms and notifications](#step-5-health-monitoring-alarms-and-notifications) + - [What you'll learn in this step](#what-youll-learn-in-this-step) + - [Tune Netdata's pre-configured alarms](#tune-netdatas-pre-configured-alarms) + - [Silence an individual alarm](#silence-an-individual-alarm) + - [Write your first health entity](#write-your-first-health-entity) + - [Enable Netdata's notification systems](#enable-netdatas-notification-systems) + - [Email notifications](#email-notifications) + - [Enable Slack notifications](#enable-slack-notifications) + - [What's next?](#whats-next) ## Tune Netdata's pre-configured alarms diff --git a/docs/guides/step-by-step/step-06.md b/docs/guides/step-by-step/step-06.md index b951a76bbd..19f533ce07 100644 --- a/docs/guides/step-by-step/step-06.md +++ b/docs/guides/step-by-step/step-06.md @@ -1,6 +1,10 @@ <!-- title: "Step 6. Collect metrics from more services and apps" +sidebar_label: "Step 6. Collect metrics from more services and apps" custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/step-by-step/step-06.md +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Guides/Step by step" --> # Step 6. Collect metrics from more services and apps @@ -21,9 +25,12 @@ source you want to monitor. We'll begin with an overview on Netdata's collector architecture, and then dive into the following: -- [Netdata's collector architecture](#netdatas-collector-architecture) -- [Enable and disable plugins](#enable-and-disable-plugins) -- [Enable the Nginx collector as an example](#example-enable-the-nginx-collector) +- [Step 6. Collect metrics from more services and apps](#step-6-collect-metrics-from-more-services-and-apps) + - [What you'll learn in this step](#what-youll-learn-in-this-step) + - [Netdata's collector architecture](#netdatas-collector-architecture) + - [Enable and disable plugins](#enable-and-disable-plugins) + - [Example: Enable the Nginx collector](#example-enable-the-nginx-collector) + - [What's next?](#whats-next) ## Netdata's collector architecture diff --git a/docs/guides/step-by-step/step-07.md b/docs/guides/step-by-step/step-07.md index 8c5c21bee4..0040a2802c 100644 --- a/docs/guides/step-by-step/step-07.md +++ b/docs/guides/step-by-step/step-07.md @@ -1,7 +1,11 @@ <!-- title: "Step 7. Netdata's dashboard in depth" +sidebar_label: "Step 7. Netdata's dashboard in depth" date: 2020-05-04 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/step-by-step/step-07.md +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Guides/Step by step" --> # Step 7. Netdata's dashboard in depth @@ -15,9 +19,12 @@ This step of the guide aims to get you more familiar with the features of the da In this step of the Netdata guide, you'll learn how to: -- [Change the dashboard's settings](#change-the-dashboards-settings) -- [Check if there's an update to Netdata](#check-if-theres-an-update-to-netdata) -- [Export and import a snapshot](#export-and-import-a-snapshot) +- [Step 7. Netdata's dashboard in depth](#step-7-netdatas-dashboard-in-depth) + - [What you'll learn in this step](#what-youll-learn-in-this-step) + - [Change the dashboard's settings](#change-the-dashboards-settings) + - [Check if there's an update to Netdata](#check-if-theres-an-update-to-netdata) + - [Export and import a snapshot](#export-and-import-a-snapshot) + - [What's next?](#whats-next) Let's get started! diff --git a/docs/guides/step-by-step/step-08.md b/docs/guides/step-by-step/step-08.md index 7a8d417f1a..64a060bce8 100644 --- a/docs/guides/step-by-step/step-08.md +++ b/docs/guides/step-by-step/step-08.md @@ -1,6 +1,10 @@ <!-- title: "Step 8. Build your first custom dashboard" +sidebar_label: "Step 8. Build your first custom dashboard" custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/step-by-step/step-08.md +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Guides/Step by step" --> # Step 8. Build your first custom dashboard @@ -14,11 +18,19 @@ really flexible. 🤸 In this step of the Netdata guide, you'll learn: -- [Why you might want a custom dashboard](#why-should-i-create-a-custom-dashboard) -- [How to create and prepare your `custom-dashboard.html` file](#create-and-prepare-your-custom-dashboardhtml-file) -- [Where to add `dashboard.js` to your custom dashboard file](#add-dashboardjs-to-your-custom-dashboard-file) -- [How to add basic styling](#add-some-basic-styling) -- [How to add charts of different types, shapes, and sizes](#creating-your-dashboards-charts) +- [Step 8. Build your first custom dashboard](#step-8-build-your-first-custom-dashboard) + - [What you'll learn in this step](#what-youll-learn-in-this-step) + - [Why should I create a custom dashboard?](#why-should-i-create-a-custom-dashboard) + - [Create and prepare your `custom-dashboard.html` file](#create-and-prepare-your-custom-dashboardhtml-file) + - [Add `dashboard.js` to your custom dashboard file](#add-dashboardjs-to-your-custom-dashboard-file) + - [Add some basic styling](#add-some-basic-styling) + - [Creating your dashboard's charts](#creating-your-dashboards-charts) + - [The chart unique ID (required)](#the-chart-unique-id-required) + - [Set chart duration](#set-chart-duration) + - [Set chart size](#set-chart-size) + - [Final touches](#final-touches) + - [The final `custom-dashboard.html`](#the-final-custom-dashboardhtml) + - [What's next?](#whats-next) Let's get on with it! diff --git a/docs/guides/step-by-step/step-09.md b/docs/guides/step-by-step/step-09.md index 839115a27f..64b33d1fa6 100644 --- a/docs/guides/step-by-step/step-09.md +++ b/docs/guides/step-by-step/step-09.md @@ -1,6 +1,10 @@ <!-- title: "Step 9. Long-term metrics storage" +sidebar_label: "Step 9. Long-term metrics storage" custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/step-by-step/step-09.md +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Guides/Step by step" --> # Step 9. Long-term metrics storage @@ -22,9 +26,12 @@ or disk it uses. Second, you can archive metrics to an external database. For th In this step of the Netdata guide, you'll learn how to: -- [Tweak the database engine's settings](#tweak-the-database-engines-settings) -- [Archive metrics to an external database](#archive-metrics-to-an-external-database) - - [Use the MongoDB database](#archive-metrics-via-the-mongodb-exporting-connector) +- [Step 9. Long-term metrics storage](#step-9-long-term-metrics-storage) + - [What you'll learn in this step](#what-youll-learn-in-this-step) + - [Tweak the database engine's settings](#tweak-the-database-engines-settings) + - [Archive metrics to an external database](#archive-metrics-to-an-external-database) + - [Archive metrics via the MongoDB exporting connector](#archive-metrics-via-the-mongodb-exporting-connector) + - [What's next?](#whats-next) Let's get started! diff --git a/docs/guides/step-by-step/step-10.md b/docs/guides/step-by-step/step-10.md index a24e803f7b..a972a47b93 100644 --- a/docs/guides/step-by-step/step-10.md +++ b/docs/guides/step-by-step/step-10.md @@ -1,6 +1,10 @@ <!-- title: "Step 10. Set up a proxy" +sidebar_label: "Step 10. Set up a proxy" custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/step-by-step/step-10.md +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Guides/Step by step" --> # Step 10. Set up a proxy @@ -24,10 +28,17 @@ publicly-accessible remote server. In this step of the Netdata guide, you'll learn: -- [What a proxy is and the benefits of using one](#wait-whats-a-proxy) -- [How to connect Netdata to Nginx](#connect-netdata-to-nginx) -- [How to enable HTTPS in Nginx](#enable-https-in-nginx) -- [How to secure your Netdata dashboard with a password](#secure-your-netdata-dashboard-with-a-password) +- [Step 10. Set up a proxy](#step-10-set-up-a-proxy) + - [What you'll learn in this step](#what-youll-learn-in-this-step) + - [Wait. What's a proxy?](#wait-whats-a-proxy) + - [Required before you start](#required-before-you-start) + - [Nginx and Certbot](#nginx-and-certbot) + - [Fully qualified domain name](#fully-qualified-domain-name) + - [Subdomain for Netdata](#subdomain-for-netdata) + - [Connect Netdata to Nginx](#connect-netdata-to-nginx) + - [Enable HTTPS in Nginx](#enable-https-in-nginx) + - [Secure your Netdata dashboard with a password](#secure-your-netdata-dashboard-with-a-password) + - [What's next?](#whats-next) Let's dive in! diff --git a/docs/guides/step-by-step/step-99.md b/docs/guides/step-by-step/step-99.md index 58902fee73..5ff2780d41 100644 --- a/docs/guides/step-by-step/step-99.md +++ b/docs/guides/step-by-step/step-99.md @@ -1,6 +1,10 @@ <!-- -title: "Step ∞. You're finished!" +title: "You're finished" custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/step-by-step/step-99.md +sidebar_label: "You're finished" +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Guides/Step by step" --> # Step ∞. You're finished! diff --git a/docs/guides/troubleshoot/monitor-debug-applications-ebpf.md b/docs/guides/troubleshoot/monitor-debug-applications-ebpf.md index c79a038ccd..17c7dbcd4c 100644 --- a/docs/guides/troubleshoot/monitor-debug-applications-ebpf.md +++ b/docs/guides/troubleshoot/monitor-debug-applications-ebpf.md @@ -1,8 +1,12 @@ <!-- title: "Monitor, troubleshoot, and debug applications with eBPF metrics" +sidebar_label: "Monitor, troubleshoot, and debug applications with eBPF metrics" description: "Use Netdata's built-in eBPF metrics collector to monitor, troubleshoot, and debug your custom application using low-level kernel feedback." image: /img/seo/guides/troubleshoot/monitor-debug-applications-ebpf.png custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/troubleshoot/monitor-debug-applications-ebpf.md +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Guides/Troubleshoot" --> # Monitor, troubleshoot, and debug applications with eBPF metrics diff --git a/docs/guides/troubleshoot/troubleshooting-agent-with-cloud-connection.md b/docs/guides/troubleshoot/troubleshooting-agent-with-cloud-connection.md index 138182e019..3e1548806b 100644 --- a/docs/guides/troubleshoot/troubleshooting-agent-with-cloud-connection.md +++ b/docs/guides/troubleshoot/troubleshooting-agent-with-cloud-connection.md @@ -1,7 +1,11 @@ <!-- title: "Troubleshoot Agent-Cloud connectivity issues" +sidebar_label: "Troubleshoot Agent-Cloud connectivity issues" description: "A simple guide to troubleshoot occurrences where the Agent is showing as offline after claiming." -custom_edit_url: https://github.com/netdata/netdata/edit/master/guides/troubleshoot/troubleshooting-agent-with-cloud-connection.md +custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/troubleshoot/troubleshooting-agent-with-cloud-connection.md +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Guides/Troubleshoot" --> # Troubleshoot Agent-Cloud connectivity issues @@ -13,9 +17,13 @@ We identified some scenarios that might cause this delay and possible actions yo The most common explanation for the delay usually falls into one of the following three categories: -- [The claiming process of the kickstart script was unsuccessful](#the-claiming-process-of-the-kickstart-script-was-unsuccessful) -- [Claiming on an older, deprecated version of the Agent](#claiming-on-an-older-deprecated-version-of-the-agent) -- [Network issues while connecting to the Cloud](#network-issues-while-connecting-to-the-cloud) +- [Troubleshoot Agent-Cloud connectivity issues](#troubleshoot-agent-cloud-connectivity-issues) + - [The claiming process of the kickstart script was unsuccessful](#the-claiming-process-of-the-kickstart-script-was-unsuccessful) + - [The kickstart script auto-claimed the Agent but there was no error message displayed](#the-kickstart-script-auto-claimed-the-agent-but-there-was-no-error-message-displayed) + - [Claiming on an older, deprecated version of the Agent](#claiming-on-an-older-deprecated-version-of-the-agent) + - [Network issues while connecting to the Cloud](#network-issues-while-connecting-to-the-cloud) + - [Verify that your IP is whitelisted from Netdata Cloud](#verify-that-your-ip-is-whitelisted-from-netdata-cloud) + - [Make sure that your node has internet connectivity and can resolve network domains](#make-sure-that-your-node-has-internet-connectivity-and-can-resolve-network-domains) ## The claiming process of the kickstart script was unsuccessful diff --git a/docs/guides/using-host-labels.md b/docs/guides/using-host-labels.md index 7937d589bf..accbf5bb17 100644 --- a/docs/guides/using-host-labels.md +++ b/docs/guides/using-host-labels.md @@ -1,6 +1,10 @@ <!-- title: "Use host labels to organize systems, metrics, and alarms" +sidebar_label: "Use host labels to organize systems, metrics, and alarms" custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/using-host-labels.md +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Guides" --> # Use host labels to organize systems, metrics, and alarms diff --git a/docs/netdata-for-IoT.md b/docs/netdata-for-IoT.md index 87b307b97b..a4a609a511 100644 --- a/docs/netdata-for-IoT.md +++ b/docs/netdata-for-IoT.md @@ -1,6 +1,10 @@ <!-- title: "Netdata for IoT" custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/netdata-for-IoT.md +sidebar_label: "Netdata for IoT" +learn_status: "Published" +learn_topic_type: "References" +learn_rel_path: "Guides" --> # Netdata for IoT diff --git a/docs/netdata-security.md b/docs/netdata-security.md index 511bc77211..61fc8ffcb8 100644 --- a/docs/netdata-security.md +++ b/docs/netdata-security.md @@ -1,6 +1,10 @@ <!-- title: "Security design" custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/netdata-security.md +sidebar_label: "Add more charts to Netdata" +learn_status: "Published" +learn_topic_type: "Concepts" +learn_rel_path: "Concepts" --> # Security design @@ -9,16 +13,21 @@ We have given special attention to all aspects of Netdata, ensuring that everyth **Table of Contents** -1. [Your data is safe with Netdata](#your-data-is-safe-with-netdata) -2. [Your systems are safe with Netdata](#your-systems-are-safe-with-netdata) -3. [Netdata is read-only](#netdata-is-read-only) -4. [Netdata viewers authentication](#netdata-viewers-authentication) - * [Why Netdata should be protected](#why-netdata-should-be-protected) - * [Protect Netdata from the internet](#protect-netdata-from-the-internet) - * [Expose Netdata only in a private LAN](#expose-netdata-only-in-a-private-lan) - * [Use an authenticating web server in proxy mode](#use-an-authenticating-web-server-in-proxy-mode) - * [Other methods](#other-methods) -5. [Registry or how to not send any information to a third party server](#registry-or-how-to-not-send-any-information-to-a-third-party-server) +- [Security design](#security-design) + - [Your data is safe with Netdata](#your-data-is-safe-with-netdata) + - [Your systems are safe with Netdata](#your-systems-are-safe-with-netdata) + - [Netdata is read-only](#netdata-is-read-only) + - [Netdata viewers authentication](#netdata-viewers-authentication) + - [Why Netdata should be protected](#why-netdata-should-be-protected) + - [Protect Netdata from the internet](#protect-netdata-from-the-internet) + - [Expose Netdata only in a private LAN](#expose-netdata-only-in-a-private-lan) + - [Fine-grained access control](#fine-grained-access-control) + - [Use an authenticating web server in proxy mode](#use-an-authenticating-web-server-in-proxy-mode) + - [Other methods](#other-methods) + - [Anonymous Statistics](#anonymous-statistics) + - [Registry or how to not send any information to a third party server](#registry-or-how-to-not-send-any-information-to-a-third-party-server) + - [Opt-out of anonymous statistics](#opt-out-of-anonymous-statistics) + - [Netdata directories](#netdata-directories) ## Your data is safe with Netdata diff --git a/docs/overview/netdata-monitoring-stack.md b/docs/overview/netdata-monitoring-stack.md index 36f5b5f06b..d7eadb0768 100644 --- a/docs/overview/netdata-monitoring-stack.md +++ b/docs/overview/netdata-monitoring-stack.md @@ -2,6 +2,10 @@ title: "Use Netdata standalone or as part of your monitoring stack" description: "Netdata can run independently or as part of a larger monitoring stack thanks to its flexibility, interoperable core, and exporting features." custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/overview/netdata-monitoring-stack.md +sidebar_label: "Use Netdata standalone or as part of your monitoring stack" +learn_status: "Published" +learn_topic_type: "References" +learn_rel_path: "Possible old, not wanted documents" --> # Use Netdata standalone or as part of your monitoring stack diff --git a/docs/overview/what-is-netdata.md b/docs/overview/what-is-netdata.md index f8e67159be..89309a09bc 100644 --- a/docs/overview/what-is-netdata.md +++ b/docs/overview/what-is-netdata.md @@ -2,6 +2,10 @@ title: "What is Netdata?" description: "Netdata is distributed, real-time performance and health monitoring for systems and applications on a single node or an entire infrastructure." custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/overview/what-is-netdata.md +sidebar_label: "What is Netdata" +learn_status: "Published" +learn_topic_type: "Concepts" +learn_rel_path: "Getting started" --> # What is Netdata? diff --git a/docs/overview/why-netdata.md b/docs/overview/why-netdata.md index 158bc50dfe..a3fce44205 100644 --- a/docs/overview/why-netdata.md +++ b/docs/overview/why-netdata.md @@ -2,6 +2,10 @@ title: "Why use Netdata?" description: "Netdata is simple to deploy, scalable, and optimized for troubleshooting. Cut the complexity and expense out of your monitoring stack." custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/overview/why-netdata.md +sidebar_label: "Why use Netdata" +learn_status: "Published" +learn_topic_type: "Concepts" +learn_rel_path: "Getting started" --> # Why use Netdata? diff --git a/docs/quickstart/infrastructure.md b/docs/quickstart/infrastructure.md index 23986b002f..b0fe3b49a2 100644 --- a/docs/quickstart/infrastructure.md +++ b/docs/quickstart/infrastructure.md @@ -1,8 +1,11 @@ <!-- title: "Infrastructure monitoring with Netdata" -sidebar_label: "Infrastructure monitoring" description: "Build a robust, infinitely scalable infrastructure monitoring solution with Netdata. Any number of nodes and every available metric." custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/quickstart/infrastructure.md +sidebar_label: "Infrastructure monitoring with Netdata" +learn_status: "Published" +learn_topic_type: "References" +learn_rel_path: "Possible old, not wanted documents" --> # Infrastructure monitoring with Netdata diff --git a/docs/quickstart/single-node.md b/docs/quickstart/single-node.md index 2937319117..304f4ffcc0 100644 --- a/docs/quickstart/single-node.md +++ b/docs/quickstart/single-node.md @@ -1,8 +1,11 @@ <!-- title: "Single-node monitoring with Netdata" -sidebar_label: "Single-node monitoring" description: "Learn dashboard basics, configuring your nodes, and collecting metrics from applications to create a powerful single-node monitoring tool." custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/quickstart/single-node.md +sidebar_label: "Infrastructure monitoring with Netdata" +learn_status: "Published" +learn_topic_type: "References" +learn_rel_path: "Possible old, not wanted documents" --> # Single-node monitoring with Netdata diff --git a/docs/visualize/create-dashboards.md b/docs/visualize/create-dashboards.md index f4306f3350..897f3a6c45 100644 --- a/docs/visualize/create-dashboards.md +++ b/docs/visualize/create-dashboards.md @@ -2,6 +2,10 @@ title: "Create new dashboards" description: "Create new dashboards in Netdata Cloud, with any number of metrics from any node on your infrastructure, for targeted troubleshooting." custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/visualize/create-dashboards.md +sidebar_label: "Create new dashboards" +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Operations/Netdata Cloud Visualizations" --> # Create new dashboards diff --git a/docs/visualize/interact-dashboards-charts.md b/docs/visualize/interact-dashboards-charts.md index bf6d7a01ff..1f680ac3b8 100644 --- a/docs/visualize/interact-dashboards-charts.md +++ b/docs/visualize/interact-dashboards-charts.md @@ -2,6 +2,10 @@ title: "Interact with dashboards and charts" description: "Zoom, highlight, and pan through time on hundreds of real-time, interactive charts to quickly discover the root cause of any anomaly." custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/visualize/interact-dashboards-charts.md +sidebar_label: "Interact with dashboards and charts" +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Operations/Netdata Cloud Visualizations" --> # Interact with dashboards and charts diff --git a/docs/visualize/overview-infrastructure.md b/docs/visualize/overview-infrastructure.md index 0daddd97a9..ff76aea260 100644 --- a/docs/visualize/overview-infrastructure.md +++ b/docs/visualize/overview-infrastructure.md @@ -2,6 +2,10 @@ title: "See an overview of your infrastructure" description: "With Netdata Cloud's War Rooms, you can see real-time metrics, from any number of nodes in your infrastructure, in composite charts." custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/visualize/overview-infrastructure.md +sidebar_label: "See an overview of your infrastructure" +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Operations/Netdata Cloud Visualizations" --> # See an overview of your infrastructure diff --git a/docs/why-netdata/1s-granularity.md b/docs/why-netdata/1s-granularity.md index 4fc7fab2d2..e3cb4f02e1 100644 --- a/docs/why-netdata/1s-granularity.md +++ b/docs/why-netdata/1s-granularity.md @@ -1,6 +1,10 @@ <!-- title: "1s granularity" custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/why-netdata/1s-granularity.md +sidebar_label: "1s granularity" +learn_status: "Published" +learn_topic_type: "Concepts" +learn_rel_path: "Concepts/Why Netdata" --> # 1s granularity diff --git a/docs/why-netdata/README.md b/docs/why-netdata/README.md index 9c3af5e7dd..1b7eeaaed5 100644 --- a/docs/why-netdata/README.md +++ b/docs/why-netdata/README.md @@ -1,6 +1,10 @@ <!-- title: "Why Netdata" custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/why-netdata/README.md +sidebar_label: "Why Netdata" +learn_status: "Published" +learn_topic_type: "Concepts" +learn_rel_path: "Concepts/Why Netdata" --> # Why Netdata diff --git a/docs/why-netdata/immediate-results.md b/docs/why-netdata/immediate-results.md index b35aa53818..78e128b192 100644 --- a/docs/why-netdata/immediate-results.md +++ b/docs/why-netdata/immediate-results.md @@ -1,6 +1,10 @@ <!-- title: "Immediate results" custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/why-netdata/immediate-results.md +sidebar_label: "Immediate results" +learn_status: "Published" +learn_topic_type: "Concepts" +learn_rel_path: "Concepts/Why Netdata" --> # Immediate results diff --git a/docs/why-netdata/meaningful-presentation.md b/docs/why-netdata/meaningful-presentation.md index fc670e33f1..e61f0f9099 100644 --- a/docs/why-netdata/meaningful-presentation.md +++ b/docs/why-netdata/meaningful-presentation.md @@ -1,6 +1,10 @@ <!-- title: "Meaningful presentation" custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/why-netdata/meaningful-presentation.md +sidebar_label: "Meaningful presentation" +learn_status: "Published" +learn_topic_type: "Concepts" +learn_rel_path: "Concepts/Why Netdata" --> # Meaningful presentation diff --git a/docs/why-netdata/unlimited-metrics.md b/docs/why-netdata/unlimited-metrics.md index b79a4ede3f..4a57577c35 100644 --- a/docs/why-netdata/unlimited-metrics.md +++ b/docs/why-netdata/unlimited-metrics.md @@ -1,6 +1,10 @@ <!-- title: "Unlimited metrics" custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/why-netdata/unlimited-metrics.md +sidebar_label: "Unlimited metrics" +learn_status: "Published" +learn_topic_type: "Concepts" +learn_rel_path: "Concepts/Why Netdata" --> # Unlimited metrics diff --git a/libnetdata/clocks/README.md b/libnetdata/clocks/README.md index 3a7ce55f9f..a641381d56 100644 --- a/libnetdata/clocks/README.md +++ b/libnetdata/clocks/README.md @@ -1,5 +1,8 @@ <!-- -custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/clocks/README.md +custom_edit_url: "https://github.com/netdata/netdata/edit/master/libnetdata/clocks/README.md" +title: "Clocks" +sidebar_label: "Clocks" +learn_status: "Published" +learn_topic_type: "References" +learn_rel_path: "Developers/libnetdata libraries" --> - - diff --git a/libnetdata/onewayalloc/README.md b/libnetdata/onewayalloc/README.md index 3fa0d9fd31..2911376121 100644 --- a/libnetdata/onewayalloc/README.md +++ b/libnetdata/onewayalloc/README.md @@ -1,6 +1,6 @@ <!-- title: "One Way Allocator" -custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/onewayallocator/README.md +custom_edit_url: "https://github.com/netdata/netdata/edit/master/libnetdata/onewayalloc/README.md" sidebar_label: "One way allocator" learn_status: "Published" learn_topic_type: "Tasks" diff --git a/libnetdata/socket/README.md b/libnetdata/socket/README.md index 70bfd3441a..91ea2609db 100644 --- a/libnetdata/socket/README.md +++ b/libnetdata/socket/README.md @@ -1,5 +1,8 @@ <!-- +Title: "Socket" custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/socket/README.md +sidebar_label: "Socket" +learn_status: "Published" +learn_topic_type: "References" +learn_rel_path: "Developers/libnetdata libraries" --> - - diff --git a/libnetdata/worker_utilization/README.md b/libnetdata/worker_utilization/README.md index 35f30b40b4..c751f935fd 100644 --- a/libnetdata/worker_utilization/README.md +++ b/libnetdata/worker_utilization/README.md @@ -1,6 +1,6 @@ <!-- title: "Worker Utilization" -custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/onewayallocator/README.md +custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/worker_utilization/README.md --> # Worker Utilization diff --git a/packaging/building-native-packages-locally.md b/packaging/building-native-packages-locally.md index 84a0fb4dbd..f887fb619f 100644 --- a/packaging/building-native-packages-locally.md +++ b/packaging/building-native-packages-locally.md @@ -1,7 +1,11 @@ <!-- -title: How to build native (DEB/RPM) packages locally for testing +title: "How to build native (DEB/RPM) packages locally for testing" +sidebar_label: "How to build native (DEB/RPM) packages locally for testing" description: Instructions for developers who need to build native packages locally for testing. custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/building-native-packages-locally.md +learn_status: "Published" +learn_topic_type: "References" +learn_rel_path: "Installation" --> # How to build native (DEB/RPM) packages locally for testing diff --git a/packaging/installer/methods/ansible.md b/packaging/installer/methods/ansible.md index ae5d9c83d5..d55098e9e1 100644 --- a/packaging/installer/methods/ansible.md +++ b/packaging/installer/methods/ansible.md @@ -1,5 +1,5 @@ <!-- -title: Deploy Netdata with Ansible +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/packaging/installer/methods/ansible.md diff --git a/packaging/installer/methods/cloud-providers.md b/packaging/installer/methods/cloud-providers.md index 6b8fa6de1f..3abbc7ede9 100644 --- a/packaging/installer/methods/cloud-providers.md +++ b/packaging/installer/methods/cloud-providers.md @@ -2,6 +2,10 @@ title: "Install Netdata on cloud providers" description: "The Netdata Agent runs on all popular cloud providers, but often requires additional steps and configuration for full functionality." custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/cloud-providers.md +sidebar_label: "Install Netdata on cloud providers" +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Installation" --> # Install Netdata on cloud providers @@ -18,9 +22,13 @@ aims to document some of those steps for popular cloud providers. > issue](https://github.com/netdata/netdata/issues/new?labels=feature+request,+needs+triage&template=feature_request.md) > with your process and instructions on using the provider's interface to complete the workaround. -- [Recommended installation methods for cloud providers](#recommended-installation-methods-for-cloud-providers) -- [Post-installation configuration](#post-installation-configuration) - - [Add a firewall rule to access Netdata's dashboard](#add-a-firewall-rule-to-access-netdatas-dashboard) +- [Install Netdata on cloud providers](#install-netdata-on-cloud-providers) + - [Recommended installation methods for cloud providers](#recommended-installation-methods-for-cloud-providers) + - [Post-installation configuration](#post-installation-configuration) + - [Add a firewall rule to access Netdata's dashboard](#add-a-firewall-rule-to-access-netdatas-dashboard) + - [Google Cloud Platform (GCP)](#google-cloud-platform-gcp) + - [Amazon Web Services (AWS) / EC2](#amazon-web-services-aws--ec2) + - [Azure](#azure) ## Recommended installation methods for cloud providers diff --git a/packaging/installer/methods/freebsd.md b/packaging/installer/methods/freebsd.md index ea7099b367..4a2ac23a3d 100644 --- a/packaging/installer/methods/freebsd.md +++ b/packaging/installer/methods/freebsd.md @@ -2,6 +2,10 @@ title: "Install Netdata on FreeBSD" description: "Install Netdata on FreeBSD to monitor the health and performance of bare metal or VMs with thousands of real-time, per-second metrics." custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/freebsd.md +sidebar_label: "Install Netdata on FreeBSD" +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Installation" --> # Install Netdata on FreeBSD diff --git a/packaging/installer/methods/freenas.md b/packaging/installer/methods/freenas.md index a69f1e3fb3..8a77210acf 100644 --- a/packaging/installer/methods/freenas.md +++ b/packaging/installer/methods/freenas.md @@ -1,6 +1,10 @@ <!-- title: "Install Netdata on FreeNAS" custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/freenas.md +sidebar_label: "Install Netdata on FreeNAS" +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Installation" --> # Install Netdata on FreeNAS diff --git a/packaging/installer/methods/pfsense.md b/packaging/installer/methods/pfsense.md index e0556629c5..63ca490d95 100644 --- a/packaging/installer/methods/pfsense.md +++ b/packaging/installer/methods/pfsense.md @@ -2,6 +2,10 @@ title: "Install Netdata on pfSense" description: "Install Netdata on pfSense to monitor the health and performance of firewalls with thousands of real-time, per-second metrics." custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/pfsense.md +sidebar_label: "Install Netdata on pfSense" +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Installation" --> # Install Netdata on pfSense diff --git a/packaging/installer/methods/synology.md b/packaging/installer/methods/synology.md index e3602df5e9..f91a83fbc5 100644 --- a/packaging/installer/methods/synology.md +++ b/packaging/installer/methods/synology.md @@ -2,6 +2,10 @@ title: "Install Netdata on Synology" description: "The Netdata Agent can be installed on AMD64-compatible NAS systems using the 64-bit pre-compiled static binary." custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/synology.md +sidebar_label: "Install Netdata on Synology" +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Installation" --> # Install Netdata on Synology diff --git a/packaging/maintainers/README.md b/packaging/maintainers/README.md index 249436d6be..6769d3e01e 100644 --- a/packaging/maintainers/README.md +++ b/packaging/maintainers/README.md @@ -2,6 +2,10 @@ title: "Package Maintainers" date: 2020-03-31 custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/maintainers/README.md +sidebar_label: "Package Maintainers" +learn_status: "Published" +learn_topic_type: "References" +learn_rel_path: "Developers" --> # Package Maintainers diff --git a/packaging/makeself/README.md b/packaging/makeself/README.md index 055b6c18bd..36c021f8ee 100644 --- a/packaging/makeself/README.md +++ b/packaging/makeself/README.md @@ -2,6 +2,10 @@ title: "Netdata static binary build" description: "Users can build the static 64-bit binary package that we ship with every release of the open-source Netdata Agent for debugging or specialize purposes." custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/makeself/README.md +sidebar_label: "Netdata static binary build" +learn_status: "Published" +learn_topic_type: "References" +learn_rel_path: "Installation" --> # Netdata static binary build diff --git a/parser/README.md b/parser/README.md index b7951864f6..cf59bfd767 100644 --- a/parser/README.md +++ b/parser/README.md @@ -1,6 +1,10 @@ <!-- title: "Parser" custom_edit_url: https://github.com/netdata/netdata/blob/master/parser/README.md +sidebar_label: "Parser" +learn_status: "Published" +learn_topic_type: "References" +learn_rel_path: "Developers/Database" --> diff --git a/streaming/README.md b/streaming/README.md index 5d55ba1ded..4e0eb801a2 100644 --- a/streaming/README.md +++ b/streaming/README.md @@ -2,6 +2,10 @@ title: "Streaming and replication" description: "Replicate and mirror Netdata's metrics through real-time streaming from child to parent nodes. Then combine, correlate, and export." 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" --> diff --git a/tests/health_mgmtapi/README.md b/tests/health_mgmtapi/README.md index aa51c0d647..73e217c206 100644 --- a/tests/health_mgmtapi/README.md +++ b/tests/health_mgmtapi/README.md @@ -1,6 +1,10 @@ <!-- title: "Health command API tester" custom_edit_url: https://github.com/netdata/netdata/edit/master/tests/health_mgmtapi/README.md +sidebar_label: "Health command API tester" +learn_status: "Published" +learn_topic_type: "References" +learn_rel_path: "Developers" --> # Health command API tester 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)  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