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 | |
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
109 files changed, 558 insertions, 100 deletions
diff --git a/build_external/README.md b/build_external/README.md index d68e4d0f10..76e9cd48ec 100644 --- a/build_external/README.md +++ b/build_external/README.md @@ -1,7 +1,10 @@ <!-- title: "External build-system" -date: 2020-03-31 custom_edit_url: https://github.com/netdata/netdata/edit/master/build_external/README.md +sidebar_label: "External build-system" +learn_status: "Published" +learn_topic_type: "References" +learn_rel_path: "Developers" --> # External build-system diff --git a/collectors/python.d.plugin/pandas/README.md b/collectors/python.d.plugin/pandas/README.md index 141549478d..36430060af 100644 --- a/collectors/python.d.plugin/pandas/README.md +++ b/collectors/python.d.plugin/pandas/README.md @@ -1,6 +1,10 @@ <!-- -title: "Pandas" custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/pandas/README.md +title: "Pandas Netdata Collector" +sidebar_label: "Pandas Netdata Collector" +learn_status: "Published" +learn_topic_type: "References" +learn_rel_path: "References/Collectors references" --> # Pandas Netdata Collector diff --git a/contrib/README.md b/contrib/README.md index 36abd3b102..2a5e640503 100644 --- a/contrib/README.md +++ b/contrib/README.md @@ -1,6 +1,10 @@ <!-- title: "Netdata contrib" custom_edit_url: https://github.com/netdata/netdata/edit/master/contrib/README.md +sidebar_label: "Netdata contrib" +learn_status: "Published" +learn_topic_type: "References" +learn_rel_path: "Developers" --> # Netdata contrib diff --git a/contribution-guidelines.md b/contribution-guidelines.md index f659298035..5828bfc2a6 100644 --- a/contribution-guidelines.md +++ b/contribution-guidelines.md @@ -685,21 +685,11 @@ Some documents, like the Ansible guide and others in the `/docs/guides` folder, this case, replace `/docs` with `/img/seo`, and then rebuild the remainder of the path to the document in question. End the path with `.png`. A member of the Netdata team will assist in creating the image when publishing the content. -For example, here is the frontmatter for the guide about [deploying the Netdata Agent with -Ansible](https://github.com/netdata/netdata/blob/master/docs/guides/deploy/ansible.md). +For example, here is the frontmatter for the guide +about [deploying the Netdata Agent with Ansible](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/ansible.md). -```markdown -<!-- -title: Deploy Netdata with Ansible -description: "Deploy an infrastructure monitoring solution in minutes with the Netdata Agent and Ansible. Use and customize a simple playbook for monitoring as code." -image: /img/seo/guides/deploy/ansible.png -custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/deploy/ansible.md ---> - -# Deploy Netdata with Ansible +<img width="751" alt="image" src="https://user-images.githubusercontent.com/43294513/217607958-ef0f270d-7947-4d91-a9a5-56b17b4255ee.png"> -... -``` Questions about frontmatter in documentation? [Ask on our community forum](https://community.netdata.cloud/c/blog-posts-and-articles/6). diff --git a/database/ram/README.md b/database/ram/README.md index 73562f0fff..b9f0531067 100644 --- a/database/ram/README.md +++ b/database/ram/README.md @@ -2,6 +2,10 @@ title: "RAM database modes" description: "Netdata's RAM database modes." custom_edit_url: https://github.com/netdata/netdata/edit/master/database/ram/README.md +sidebar_label: "RAM database modes" +learn_status: "Published" +learn_topic_type: "References" +learn_rel_path: "Developers/Database" --> # RAM modes
\ No newline at end of file diff --git a/docs/Add-more-charts-to-netdata.md b/docs/Add-more-charts-to-netdata.md index 35a89fba07..b1530431e8 100644 --- a/docs/Add-more-charts-to-netdata.md +++ b/docs/Add-more-charts-to-netdata.md @@ -1,6 +1,10 @@ <!-- title: "Add more charts to Netdata" custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Add-more-charts-to-netdata.md +sidebar_label: "Add more charts to Netdata" +learn_status: "Published" +learn_topic_type: "References" +learn_rel_path: "Possible old, not wanted documents" --> # Add more charts to Netdata diff --git a/docs/Demo-Sites.md b/docs/Demo-Sites.md index 5c4d1018fd..95448f9439 100644 --- a/docs/Demo-Sites.md +++ b/docs/Demo-Sites.md @@ -2,6 +2,10 @@ title: "Demo sites" date: 2020-03-26 custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Demo-Sites.md +sidebar_label: "Demo sites" +learn_status: "Published" +learn_topic_type: "References" +learn_rel_path: "Possible old, not wanted documents" |