diff options
author | Fotis Voutsas <fotis@netdata.cloud> | 2023-02-08 19:48:19 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-02-08 09:48:19 -0800 |
commit | 2c60f324eea8970b25283c62acabaf9ae023dbff (patch) | |
tree | c781ea9b642c5b0afd4038109a56ad876fd97af5 /docs | |
parent | 3f8806b3289489979880e799a2f45f18ffd34f8e (diff) |
Add markdown files in Learn (#14466)
* add metadata for learn
* first batch of adding metadata to md files
* second batch of adding metadata to md files
* third batch of adding metadata to md files
* test one sidebar_label
* add missing sidebar_labels
* add missing sidebar_labels to files left behind
* test, ansible doc is stubborn
* fix
* fix
* fix
* don't use questionmarks in the sidebar label
* don't use exclamation marks and symbols in the sidebar label
* fix style guide
* fixes
* fixes
Diffstat (limited to 'docs')
61 files changed, 355 insertions, 68 deletions
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" --> |