diff options
author | Joel Hans <joel@netdata.cloud> | 2020-03-10 15:29:51 -0600 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-03-10 14:29:51 -0700 |
commit | 9342704a41cbd20a315e55f0b1ff3efd9f039498 (patch) | |
tree | 22cebf2a80622ac644e007189c912e4669598bb6 /docs | |
parent | 629e24ae952137657c3106db9783b985450e13f7 (diff) |
Bulk add frontmatter to all documentation (#8354)
* Bulk add frontmatter
* A few extra edge cases
Diffstat (limited to 'docs')
48 files changed, 333 insertions, 2 deletions
diff --git a/docs/Add-more-charts-to-netdata.md b/docs/Add-more-charts-to-netdata.md index 5ff3172907..9935daa890 100644 --- a/docs/Add-more-charts-to-netdata.md +++ b/docs/Add-more-charts-to-netdata.md @@ -1,3 +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 +--- +--> + # Add more charts to Netdata This file has been deprecated. Please see our [collectors docs](../collectors/README.md) or the collectors [quickstart diff --git a/docs/Demo-Sites.md b/docs/Demo-Sites.md index 6bb501de43..4aef33b202 100644 --- a/docs/Demo-Sites.md +++ b/docs/Demo-Sites.md @@ -1,3 +1,10 @@ +<!-- +--- +title: "Demo sites" +custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Demo-Sites.md +--- +--> + # Demo sites Live demo installations of Netdata are available at **[https://www.netdata.cloud](https://www.netdata.cloud/#live-demo)**: diff --git a/docs/Donations-netdata-has-received.md b/docs/Donations-netdata-has-received.md index 8b46980ae1..588229378f 100644 --- a/docs/Donations-netdata-has-received.md +++ b/docs/Donations-netdata-has-received.md @@ -1,3 +1,10 @@ +<!-- +--- +title: "Donations" +custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Donations-netdata-has-received.md +--- +--> + # Donations This is a list of the donations we have received for Netdata (sorted alphabetically on their name): diff --git a/docs/Performance.md b/docs/Performance.md index 435de0f820..9daf54ebfd 100644 --- a/docs/Performance.md +++ b/docs/Performance.md @@ -1,3 +1,10 @@ +<!-- +--- +title: "Performance" +custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Performance.md +--- +--> + # Performance Netdata performance is affected by: diff --git a/docs/README.md b/docs/README.md index 752802f6d4..1097e5a839 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,3 +1,10 @@ +<!-- +--- +title: "Read documentation on <https://docs.netdata.cloud>" +custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/README.md +--- +--> + # Read documentation on <https://docs.netdata.cloud> Welcome to the Netdata documentation! While you can read Netdata documentation here, or throughout the Netdata repository, our intention is that these pages are read on [docs.netdata.cloud](https://docs.netdata.cloud). diff --git a/docs/Running-behind-apache.md b/docs/Running-behind-apache.md index 4d872764cc..b6e9743b2d 100644 --- a/docs/Running-behind-apache.md +++ b/docs/Running-behind-apache.md @@ -1,3 +1,10 @@ +<!-- +--- +title: "Netdata via apache's mod_proxy" +custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Running-behind-apache.md +--- +--> + # Netdata via apache's mod_proxy Below you can find instructions for configuring an apache server to: diff --git a/docs/Running-behind-caddy.md b/docs/Running-behind-caddy.md index 866d488d06..01934b5749 100644 --- a/docs/Running-behind-caddy.md +++ b/docs/Running-behind-caddy.md @@ -1,3 +1,10 @@ +<!-- +--- +title: "Netdata via Caddy" +custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Running-behind-caddy.md +--- +--> + # Netdata via Caddy To run Netdata via [Caddy's proxying,](https://caddyserver.com/docs/proxy) set your Caddyfile up like this: diff --git a/docs/Running-behind-haproxy.md b/docs/Running-behind-haproxy.md index a50cccb425..28e7761563 100644 --- a/docs/Running-behind-haproxy.md +++ b/docs/Running-behind-haproxy.md @@ -1,3 +1,10 @@ +<!-- +--- +title: "Netdata via HAProxy" +custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Running-behind-haproxy.md +--- +--> + # Netdata via HAProxy > HAProxy is a free, very fast and reliable solution offering high availability, load balancing, diff --git a/docs/Running-behind-lighttpd.md b/docs/Running-behind-lighttpd.md index 8f05973b8b..25c62cff4d 100644 --- a/docs/Running-behind-lighttpd.md +++ b/docs/Running-behind-lighttpd.md @@ -1,3 +1,10 @@ +<!-- +--- +title: "Netdata via lighttpd v1.4.x" +custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Running-behind-lighttpd.md +--- +--> + # Netdata via lighttpd v1.4.x Here is a config for accessing Netdata in a suburl via lighttpd 1.4.46 and newer: diff --git a/docs/Running-behind-nginx.md b/docs/Running-behind-nginx.md index 99e5e601df..6e1083ac20 100644 --- a/docs/Running-behind-nginx.md +++ b/docs/Running-behind-nginx.md @@ -1,3 +1,10 @@ +<!-- +--- +title: "Running Netdata behind Nginx" +custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Running-behind-nginx.md +--- +--> + # Running Netdata behind Nginx ## Intro diff --git a/docs/a-github-star-is-important.md b/docs/a-github-star-is-important.md index a69257a231..6730dfecfe 100644 --- a/docs/a-github-star-is-important.md +++ b/docs/a-github-star-is-important.md @@ -1,3 +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 +--- +--> + # A GitHub star is important **GitHub stars** allow Netdata to expand its reach, its community, especially attract people with skills willing to diff --git a/docs/anonymous-statistics.md b/docs/anonymous-statistics.md index 2afbddc18f..bb859b4da7 100644 --- a/docs/anonymous-statistics.md +++ b/docs/anonymous-statistics.md @@ -1,3 +1,10 @@ +<!-- +--- +title: "Anonymous statistics" +custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/anonymous-statistics.md +--- +--> + # Anonymous statistics Starting with v1.12, Netdata collects anonymous usage information by default and sends it to Google Analytics. We use diff --git a/docs/configuration-guide.md b/docs/configuration-guide.md index a30149cb2a..7ea5cc0205 100644 --- a/docs/configuration-guide.md +++ b/docs/configuration-guide.md @@ -1,3 +1,10 @@ +<!-- +--- +title: "Configuration guide" +custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/configuration-guide.md +--- +--> + # Configuration guide No configuration is required to run Netdata, but you will find plenty of options to tweak, so that you can adapt it to diff --git a/docs/contributing/contributing-documentation.md b/docs/contributing/contributing-documentation.md index 9d4b5acf36..faff4eeb2d 100644 --- a/docs/contributing/contributing-documentation.md +++ b/docs/contributing/contributing-documentation.md @@ -1,3 +1,10 @@ +<!-- +--- +title: "Contributing to documentation" +custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/contributing/contributing-documentation.md +--- +--> + # Contributing to documentation We welcome contributions to Netdata's already extensive documentation, which we host at diff --git a/docs/contributing/style-guide.md b/docs/contributing/style-guide.md index 310e901484..6ff684e406 100644 --- a/docs/contributing/style-guide.md +++ b/docs/contributing/style-guide.md @@ -1,3 +1,10 @@ +<!-- +--- +title: "Netdata style guide" +custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/contributing/style-guide.md +--- +--> + # Netdata style guide This in-progress style guide establishes editorial guidelines for anyone who wants to write documentation for Netdata diff --git a/docs/getting-started.md b/docs/getting-started.md index 96dd9ebb64..67e4fa6e96 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -1,3 +1,10 @@ +<!-- +--- +title: "Getting started guide" +custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/getting-started.md +--- +--> + # Getting started guide Thanks for trying Netdata! In this getting started guide, we'll quickly walk you through the first steps you should take diff --git a/docs/high-performance-netdata.md b/docs/high-performance-netdata.md index fd6fd9e006..89272fe2b5 100644 --- a/docs/high-performance-netdata.md +++ b/docs/high-performance-netdata.md @@ -1,3 +1,10 @@ +<!-- +--- +title: "High performance Netdata" +custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/high-performance-netdata.md +--- +--> + # High performance Netdata If you plan to run a Netdata public on the internet, you will get the most performance out of it by following these diff --git a/docs/netdata-cloud/README.md b/docs/netdata-cloud/README.md index 9ed6330b5e..19cbdf2a75 100644 --- a/docs/netdata-cloud/README.md +++ b/docs/netdata-cloud/README.md @@ -1,3 +1,10 @@ +<!-- +--- +title: "Netdata Cloud" +custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/netdata-cloud/README.md +--- +--> + # Netdata Cloud Netdata Cloud is core to our ongoing mission to provide real-time, distributed health monitoring and performance troubleshooting. It's the foundation of an ecosystem of tools that will help you build more extraordinary infrastructures. diff --git a/docs/netdata-cloud/nodes-view.md b/docs/netdata-cloud/nodes-view.md index 1e91639d7a..f944e905a1 100644 --- a/docs/netdata-cloud/nodes-view.md +++ b/docs/netdata-cloud/nodes-view.md @@ -1,3 +1,10 @@ +<!-- +--- +title: "Using the Nodes View" +custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/netdata-cloud/nodes-view.md +--- +--> + # Using the Nodes View ## Introduction diff --git a/docs/netdata-cloud/signing-in.md b/docs/netdata-cloud/signing-in.md index cf99931dd4..dbc1119dd3 100644 --- a/docs/netdata-cloud/signing-in.md +++ b/docs/netdata-cloud/signing-in.md @@ -1,3 +1,10 @@ +<!-- +--- +title: "Registration and signing in" +custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/netdata-cloud/signing-in.md +--- +--> + # Registration and signing in To use the features of [Netdata Cloud](README.md), you must first register an account with Netdata Cloud and associate your first Netdata node with the Netdata Cloud [registry](../../registry/README.md). **Netdata Cloud is entirely free for all Netdata users**, and does not store any metrics created by your machines. You keep your data—Netdata Cloud just connects it all together. diff --git a/docs/netdata-for-IoT.md b/docs/netdata-for-IoT.md index 716822bf0a..229d5aaa57 100644 --- a/docs/netdata-for-IoT.md +++ b/docs/netdata-for-IoT.md @@ -1,3 +1,10 @@ +<!-- +--- +title: "Netdata for IoT" +custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/netdata-for-IoT.md +--- +--> + # Netdata for IoT ![image1](https://cloud.githubusercontent.com/assets/2662304/14252446/11ae13c4-fa90-11e5-9d03-d93a3eb3317a.gif) diff --git a/docs/netdata-security.md b/docs/netdata-security.md index dbb9a11e6e..f149f2d453 100644 --- a/docs/netdata-security.md +++ b/docs/netdata-security.md @@ -1,3 +1,10 @@ +<!-- +--- +title: "Security design" +custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/netdata-security.md +--- +--> + # Security design We have given special attention to all aspects of Netdata, ensuring that everything throughout its operation is as secure as possible. Netdata has been designed with security in mind. diff --git a/docs/privacy-policy.md b/docs/privacy-policy.md index 9ac0bfeccd..16b241f751 100644 --- a/docs/privacy-policy.md +++ b/docs/privacy-policy.md @@ -1,3 +1,10 @@ +<!-- +--- +title: "Privacy Policy" +custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/privacy-policy.md +--- +--> + # Privacy Policy ## 1. Preamble diff --git a/docs/step-by-step/step-00.md b/docs/step-by-step/step-00.md index 7027e210c2..f01dcb6532 100644 --- a/docs/step-by-step/step-00.md +++ b/docs/step-by-step/step-00.md @@ -1,7 +1,9 @@ +<!-- --- -title: The step-by-step Netdata tutorial -description: Learn what Netdata is, what it's capable of, and how it'll help you make faster and more informed decisions about the health and performance of your systems and applications. +title: "The step-by-step Netdata tutorial" +custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/step-by-step/step-00.md --- +--> # The step-by-step Netdata tutorial diff --git a/docs/step-by-step/step-01.md b/docs/step-by-step/step-01.md index 91be268f73..dc72214f32 100644 --- a/docs/step-by-step/step-01.md +++ b/docs/step-by-step/step-01.md @@ -1,3 +1,10 @@ +<!-- +--- +title: "Step 1. Netdata's building blocks" +custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/step-by-step/step-01.md +--- +--> + # Step 1. Netdata's building blocks Netdata is a distributed and real-time _health monitoring and performance troubleshooting toolkit_ for monitoring your diff --git a/docs/step-by-step/step-02.md b/docs/step-by-step/step-02.md index c9a0b120e5..fafe1f5e30 100644 --- a/docs/step-by-step/step-02.md +++ b/docs/step-by-step/step-02.md @@ -1,3 +1,10 @@ +<!-- +--- +title: "Step 2. Get to know Netdata's dashboard" +custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/step-by-step/step-02.md +--- +--> + # Step 2. Get to know Netdata's dashboard Welcome to Netdata proper! Now that you understand how Netdata works, how it's built, and why we built it, you can start diff --git a/docs/step-by-step/step-03.md b/docs/step-by-step/step-03.md index 460f43573a..8f1d598945 100644 --- a/docs/step-by-step/step-03.md +++ b/docs/step-by-step/step-03.md @@ -1,3 +1,10 @@ +<!-- +--- +title: "Step 3. Monitor more than one system with Netdata" +custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/step-by-step/step-03.md +--- +--> + # Step 3. Monitor more than one system with Netdata The Netdata agent is _distributed_ by design. That means each agent operates independently from any other, collecting diff --git a/docs/step-by-step/step-04.md b/docs/step-by-step/step-04.md index 47bba6b8b5..d403e208d7 100644 --- a/docs/step-by-step/step-04.md +++ b/docs/step-by-step/step-04.md @@ -1,3 +1,10 @@ +<!-- +--- +title: "Step 4. The basics of configuring Netdata" +custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/step-by-step/step-04.md +--- +--> + # Step 4. The basics of configuring Netdata Welcome to the fourth step of the Netdata tutorial. diff --git a/docs/step-by-step/step-05.md b/docs/step-by-step/step-05.md index 26837e29bf..7f4f9e6f51 100644 --- a/docs/step-by-step/step-05.md +++ b/docs/step-by-step/step-05.md @@ -1,3 +1,10 @@ +<!-- +--- +title: "Step 5. Health monitoring alarms and notifications" +custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/step-by-step/step-05.md +--- +--> + # Step 5. Health monitoring alarms and notifications In the fifth step of the Netdata tutorial, we're introducing you to one of our core features: **health monitoring**. diff --git a/docs/step-by-step/step-06.md b/docs/step-by-step/step-06.md index c0ac50aa18..57c3885353 100644 --- a/docs/step-by-step/step-06.md +++ b/docs/step-by-step/step-06.md @@ -1,3 +1,10 @@ +<!-- +--- +title: "Step 6. Collect metrics from more services and apps" +custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/step-by-step/step-06.md +--- +--> + # Step 6. Collect metrics from more services and apps When Netdata _starts_, it auto-detects dozens of **data sources**, such as database servers, web servers, and more. diff --git a/docs/step-by-step/step-07.md b/docs/step-by-step/step-07.md index 395c3bc65d..10426e4241 100644 --- a/docs/step-by-step/step-07.md +++ b/docs/step-by-step/step-07.md @@ -1,3 +1,10 @@ +<!-- +--- +title: "Step 7. Netdata's dashboard in depth" +custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/step-by-step/step-07.md +--- +--> + # Step 7. Netdata's dashboard in depth Welcome to the seventh step of the Netdata guide! diff --git a/docs/step-by-step/step-08.md b/docs/step-by-step/step-08.md index 5d477db7ff..caf6308380 100644 --- a/docs/step-by-step/step-08.md +++ b/docs/step-by-step/step-08.md @@ -1,3 +1,10 @@ +<!-- +--- +title: "Step 8. Build your first custom dashboard" +custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/step-by-step/step-08.md +--- +--> + # Step 8. Build your first custom dashboard In previous steps of the tutorial, you have learned how several sections of the Netdata dashboard worked. diff --git a/docs/step-by-step/step-09.md b/docs/step-by-step/step-09.md index da7e703c99..f0a4faa933 100644 --- a/docs/step-by-step/step-09.md +++ b/docs/step-by-step/step-09.md @@ -1,3 +1,10 @@ +<!-- +--- +title: "Step 9. Long-term metrics storage" +custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/step-by-step/step-09.md +--- +--> + # Step 9. Long-term metrics storage By default, Netdata stores metrics in a custom database we call the [database engine](../../database/engine/), which diff --git a/docs/step-by-step/step-10.md b/docs/step-by-step/step-10.md index ae141577ff..5faf30af57 100644 --- a/docs/step-by-step/step-10.md +++ b/docs/step-by-step/step-10.md @@ -1,3 +1,10 @@ +<!-- +--- +title: "Step 10. Set up a proxy" +custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/step-by-step/step-10.md +--- +--> + # Step 10. Set up a proxy You're almost through! At this point, you should be pretty familiar with now Netdata works and how to configure it to diff --git a/docs/step-by-step/step-99.md b/docs/step-by-step/step-99.md index 8ee273aef3..dc55673c7d 100644 --- a/docs/step-by-step/step-99.md +++ b/docs/step-by-step/step-99.md @@ -1,3 +1,10 @@ +<!-- +--- +title: "Step ∞. You're finished!" +custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/step-by-step/step-99.md +--- +--> + # Step ∞. You're finished! Congratulations. 🎉 diff --git a/docs/terms-of-use.md b/docs/terms-of-use.md index bf77fabbfd..652dbc97f1 100644 --- a/docs/terms-of-use.md +++ b/docs/terms-of-use.md @@ -1,3 +1,10 @@ +<!-- +--- +title: "Terms of Use" +custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/terms-of-use.md +--- +--> + # Terms of Use Netdata Master Terms of Use diff --git a/docs/tutorials/collect-apache-nginx-web-logs.md b/docs/tutorials/collect-apache-nginx-web-logs.md index 1d7c4d7ba6..86ddf8a5b7 100644 --- a/docs/tutorials/collect-apache-nginx-web-logs.md +++ b/docs/tutorials/collect-apache-nginx-web-logs.md @@ -1,3 +1,10 @@ +<!-- +--- +title: "Monitor Nginx or Apache web server log files with Netdata" +custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/tutorials/collect-apache-nginx-web-logs.md +--- +--> + # Monitor Nginx or Apache web server log files with Netdata Log files have been a critical resource for developers and system administrators who want to understand the health and diff --git a/docs/tutor |