From 8084ad2a329f9f2535966bd34796c92b6f4d3ed4 Mon Sep 17 00:00:00 2001 From: Fotis Voutsas <fotis@netdata.cloud> Date: Wed, 24 May 2023 17:28:50 +0300 Subject: [PATCH] Create category overview pages for learn's restructure (#15091) Co-authored-by: Ilya Mashchenko <ilya@netdata.cloud> --- .../accessing-netdata-dashboards.md | 3 +++ .../build-the-netdata-agent-yourself.md | 3 +++ .../install-netdata-on-embedded-systems.md | 3 +++ .../install-with-a-cicd-provisioning-system.md | 3 +++ ...ne-learning-and-assisted-troubleshooting.md | 3 +++ ...maintenance-operations-on-netdata-agents.md | 3 +++ .../metrics-streaming-and-replication.md | 3 +++ docs/category-overview-pages/misc-overview.md | 18 +----------------- .../monitor-your-infrastructure.md | 3 +++ docs/category-overview-pages/netdata-apis.md | 5 +++++ .../netdata-architecture.md | 3 +++ .../netdata-dashboards-and-visualizations.md | 3 +++ .../optimizing-metrics-database.md | 3 +++ 13 files changed, 39 insertions(+), 17 deletions(-) create mode 100644 docs/category-overview-pages/accessing-netdata-dashboards.md create mode 100644 docs/category-overview-pages/build-the-netdata-agent-yourself.md create mode 100644 docs/category-overview-pages/install-netdata-on-embedded-systems.md create mode 100644 docs/category-overview-pages/install-with-a-cicd-provisioning-system.md create mode 100644 docs/category-overview-pages/machine-learning-and-assisted-troubleshooting.md create mode 100644 docs/category-overview-pages/maintenance-operations-on-netdata-agents.md create mode 100644 docs/category-overview-pages/metrics-streaming-and-replication.md create mode 100644 docs/category-overview-pages/monitor-your-infrastructure.md create mode 100644 docs/category-overview-pages/netdata-apis.md create mode 100644 docs/category-overview-pages/netdata-architecture.md create mode 100644 docs/category-overview-pages/netdata-dashboards-and-visualizations.md create mode 100644 docs/category-overview-pages/optimizing-metrics-database.md diff --git a/docs/category-overview-pages/accessing-netdata-dashboards.md b/docs/category-overview-pages/accessing-netdata-dashboards.md new file mode 100644 index 0000000000..46c0bcff17 --- /dev/null +++ b/docs/category-overview-pages/accessing-netdata-dashboards.md @@ -0,0 +1,3 @@ +# Accessing Netdata Dashboards + +This section contains documentation on how you can access the Netdata Agent's dashboards, and the Netdata Cloud's dashboards. \ No newline at end of file diff --git a/docs/category-overview-pages/build-the-netdata-agent-yourself.md b/docs/category-overview-pages/build-the-netdata-agent-yourself.md new file mode 100644 index 0000000000..99166ad951 --- /dev/null +++ b/docs/category-overview-pages/build-the-netdata-agent-yourself.md @@ -0,0 +1,3 @@ +# Build the Netdata Agent yourself + +This section contains documentation on all the ways that you can build the Netdata Agent. \ No newline at end of file diff --git a/docs/category-overview-pages/install-netdata-on-embedded-systems.md b/docs/category-overview-pages/install-netdata-on-embedded-systems.md new file mode 100644 index 0000000000..dfaa4482c2 --- /dev/null +++ b/docs/category-overview-pages/install-netdata-on-embedded-systems.md @@ -0,0 +1,3 @@ +# Install Netdata on Embedded Systems Overview + +This section contains documentation for installation methods when it comes to Embedded Systems. \ No newline at end of file diff --git a/docs/category-overview-pages/install-with-a-cicd-provisioning-system.md b/docs/category-overview-pages/install-with-a-cicd-provisioning-system.md new file mode 100644 index 0000000000..30a5a706cd --- /dev/null +++ b/docs/category-overview-pages/install-with-a-cicd-provisioning-system.md @@ -0,0 +1,3 @@ +# Install with a CI/CD Provisioning System Overview + +This section contains documentation on all the installation methods through a CI/CD system. \ No newline at end of file diff --git a/docs/category-overview-pages/machine-learning-and-assisted-troubleshooting.md b/docs/category-overview-pages/machine-learning-and-assisted-troubleshooting.md new file mode 100644 index 0000000000..074051e3ec --- /dev/null +++ b/docs/category-overview-pages/machine-learning-and-assisted-troubleshooting.md @@ -0,0 +1,3 @@ +# Machine Learning and Assisted Troubleshooting Overview + +This section contains documentation regarding Netdata's troubleshooting and machine learning features. \ No newline at end of file diff --git a/docs/category-overview-pages/maintenance-operations-on-netdata-agents.md b/docs/category-overview-pages/maintenance-operations-on-netdata-agents.md new file mode 100644 index 0000000000..207a0bd327 --- /dev/null +++ b/docs/category-overview-pages/maintenance-operations-on-netdata-agents.md @@ -0,0 +1,3 @@ +# Maintenance operations on Netdata Agents Overview + +This section provides information on various actions you can take when maintaining a Netdata Agent. \ No newline at end of file diff --git a/docs/category-overview-pages/metrics-streaming-and-replication.md b/docs/category-overview-pages/metrics-streaming-and-replication.md new file mode 100644 index 0000000000..37b040e9ed --- /dev/null +++ b/docs/category-overview-pages/metrics-streaming-and-replication.md @@ -0,0 +1,3 @@ +# Metrics Streaming and Replication Overview + +This section contains documentation to help you understand and configure streaming and replication with Netdata. \ No newline at end of file diff --git a/docs/category-overview-pages/misc-overview.md b/docs/category-overview-pages/misc-overview.md index e0c1cc0d19..dbb11e9bc8 100644 --- a/docs/category-overview-pages/misc-overview.md +++ b/docs/category-overview-pages/misc-overview.md @@ -1,19 +1,3 @@ -<!-- -title: "Miscellaneous material" -sidebar_label: "Miscellaneous" -custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/category-overview-pages/misc-overview.md" -description: "Available integrations in Netdata" -learn_status: "Published" -learn_rel_path: "Miscellaneous" -sidebar_position: 110 ---> - # Miscellaneous material -This section contains temporary material that no longer belongs in our official documentation, and will -be moved to other locations. We keep it here to make it accessible while we create the new articles. - - - - - +This section contains material that will be moved to new locations as we see fit. We keep it here to make it accessible while we make these changes. \ No newline at end of file diff --git a/docs/category-overview-pages/monitor-your-infrastructure.md b/docs/category-overview-pages/monitor-your-infrastructure.md new file mode 100644 index 0000000000..3582e88a68 --- /dev/null +++ b/docs/category-overview-pages/monitor-your-infrastructure.md @@ -0,0 +1,3 @@ +# Monitor your Infrastructure Overview + +This section contains documentation on how you can use Netdata Cloud and it's features to monitor your entire infrastructure. \ No newline at end of file diff --git a/docs/category-overview-pages/netdata-apis.md b/docs/category-overview-pages/netdata-apis.md new file mode 100644 index 0000000000..82d1c1752e --- /dev/null +++ b/docs/category-overview-pages/netdata-apis.md @@ -0,0 +1,5 @@ +# Netdata APIs Overview + +This section contains information about Netdata's APIs. + +You can access the Netdata Agent's API through swagger UI [here](/api). \ No newline at end of file diff --git a/docs/category-overview-pages/netdata-architecture.md b/docs/category-overview-pages/netdata-architecture.md new file mode 100644 index 0000000000..70f1265977 --- /dev/null +++ b/docs/category-overview-pages/netdata-architecture.md @@ -0,0 +1,3 @@ +# Netdata Architecture Overview + +This section's purpose is to explain the architecture of Netdata, the role of the Agent and the Cloud, and more. \ No newline at end of file diff --git a/docs/category-overview-pages/netdata-dashboards-and-visualizations.md b/docs/category-overview-pages/netdata-dashboards-and-visualizations.md new file mode 100644 index 0000000000..cc9304365f --- /dev/null +++ b/docs/category-overview-pages/netdata-dashboards-and-visualizations.md @@ -0,0 +1,3 @@ +# Netdata Dashboards and Visualizations Overview + +This section provides documentation about all the visualization operations, features and insights that Netdata provides. \ No newline at end of file diff --git a/docs/category-overview-pages/optimizing-metrics-database.md b/docs/category-overview-pages/optimizing-metrics-database.md new file mode 100644 index 0000000000..fdbd3b690c --- /dev/null +++ b/docs/category-overview-pages/optimizing-metrics-database.md @@ -0,0 +1,3 @@ +# Optimizing Metrics Database Overview + +This section contains documentation to help you understand how the metrics DB works, understand the key features and configure them to suit your needs. \ No newline at end of file