diff options
author | Fotis Voutsas <fotis@netdata.cloud> | 2023-01-25 15:29:33 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-01-25 15:29:33 +0200 |
commit | 0541c97e531bc7220b2879eb8a4139df0dc821b8 (patch) | |
tree | 7226f7804349940d92533564c8bab07fd78e5eb4 /exporting | |
parent | f4d017ccf7385df3e152eeb5ea1259702ab01043 (diff) |
Introduce the new Structure of the documentation (#13915)
* Moving the cloud docs under /docs/cloud (previous location: netdata/learn/*)
* Added metadata on almost every document of the old learn site for the new ingest process of learn.
* Map old learn document to their best fit as topic related docs.
Signed-off-by: Tasos Katsoulas <tasos@netdata.cloud>
Co-authored-by: DShreve2 <david@netdata.cloud>
Co-authored-by: hugovalente-pm <hugo@netdata.cloud>
Diffstat (limited to 'exporting')
-rw-r--r-- | exporting/README.md | 8 | ||||
-rw-r--r-- | exporting/TIMESCALE.md | 8 | ||||
-rw-r--r-- | exporting/WALKTHROUGH.md | 7 | ||||
-rw-r--r-- | exporting/aws_kinesis/README.md | 8 | ||||
-rw-r--r-- | exporting/graphite/README.md | 8 | ||||
-rw-r--r-- | exporting/json/README.md | 8 | ||||
-rw-r--r-- | exporting/mongodb/README.md | 8 | ||||
-rw-r--r-- | exporting/opentsdb/README.md | 8 | ||||
-rw-r--r-- | exporting/prometheus/README.md | 7 | ||||
-rw-r--r-- | exporting/prometheus/remote_write/README.md | 7 | ||||
-rw-r--r-- | exporting/pubsub/README.md | 8 |
11 files changed, 64 insertions, 21 deletions
diff --git a/exporting/README.md b/exporting/README.md index 60028a38a9..48aefbcea8 100644 --- a/exporting/README.md +++ b/exporting/README.md @@ -1,8 +1,12 @@ <!-- title: "Exporting reference" description: "With the exporting engine, you can archive your Netdata metrics to multiple external databases for long-term storage or further analysis." -sidebar_label: Exporting reference -custom_edit_url: https://github.com/netdata/netdata/edit/master/exporting/README.md +sidebar_label: "Exporting reference" +custom_edit_url: "https://github.com/netdata/netdata/edit/master/exporting/README.md" +learn_status: "Published" +learn_topic_type: "References" +learn_rel_path: "References/Configuration" +learn_doc_purpose: "Explain the exporting engine options and all of our the exporting connectors options" --> # Exporting reference diff --git a/exporting/TIMESCALE.md b/exporting/TIMESCALE.md index 07aa1b7a20..2bd6db8c52 100644 --- a/exporting/TIMESCALE.md +++ b/exporting/TIMESCALE.md @@ -1,8 +1,12 @@ <!-- title: "Writing metrics to TimescaleDB" description: "Send Netdata metrics to TimescaleDB for long-term archiving and further analysis." -custom_edit_url: https://github.com/netdata/netdata/edit/master/exporting/TIMESCALE.md -sidebar_label: Writing metrics to TimescaleDB +custom_edit_url: "https://github.com/netdata/netdata/edit/master/exporting/TIMESCALE.md" +sidebar_label: "Writing metrics to TimescaleDB" +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Setup/Exporting connectors" +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> # Writing metrics to TimescaleDB diff --git a/exporting/WALKTHROUGH.md b/exporting/WALKTHROUGH.md index 0612b298a7..52cbb8ec4c 100644 --- a/exporting/WALKTHROUGH.md +++ b/exporting/WALKTHROUGH.md @@ -1,8 +1,11 @@ <!-- title: "Exporting to Netdata, Prometheus, Grafana stack" description: "Using Netdata in conjunction with Prometheus and Grafana." -custom_edit_url: https://github.com/netdata/netdata/edit/master/exporting/WALKTHROUGH.md -sidebar_label: Netdata, Prometheus, Grafana stack +custom_edit_url: "https://github.com/netdata/netdata/edit/master/exporting/WALKTHROUGH.md" +sidebar_label: "Netdata, Prometheus, Grafana stack" +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Setup/Exporting connectors" --> # Netdata, Prometheus, Grafana stack diff --git a/exporting/aws_kinesis/README.md b/exporting/aws_kinesis/README.md index 29dd3438ec..0aff906efc 100644 --- a/exporting/aws_kinesis/README.md +++ b/exporting/aws_kinesis/README.md @@ -1,8 +1,12 @@ <!-- title: "Export metrics to AWS Kinesis Data Streams" description: "Archive your Agent's metrics to AWS Kinesis Data Streams for long-term storage, further analysis, or correlation with data from other sources." -custom_edit_url: https://github.com/netdata/netdata/edit/master/exporting/aws_kinesis/README.md -sidebar_label: AWS Kinesis Data Streams +custom_edit_url: "https://github.com/netdata/netdata/edit/master/exporting/aws_kinesis/README.md" +sidebar_label: "AWS Kinesis Data Streams" +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Setup/Exporting connectors" +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> # Export metrics to AWS Kinesis Data Streams diff --git a/exporting/graphite/README.md b/exporting/graphite/README.md index 6c96c78c92..faf79b2365 100644 --- a/exporting/graphite/README.md +++ b/exporting/graphite/README.md @@ -1,8 +1,12 @@ <!-- title: "Export metrics to Graphite providers" description: "Archive your Agent's metrics to a any Graphite database provider for long-term storage, further analysis, or correlation with data from other sources." -custom_edit_url: https://github.com/netdata/netdata/edit/master/exporting/graphite/README.md -sidebar_label: Graphite +custom_edit_url: "https://github.com/netdata/netdata/edit/master/exporting/graphite/README.md" +sidebar_label: "Graphite" +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Setup/Exporting connectors" +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> # Export metrics to Graphite providers diff --git a/exporting/json/README.md b/exporting/json/README.md index d129ffbd79..bd94d7f78f 100644 --- a/exporting/json/README.md +++ b/exporting/json/README.md @@ -1,8 +1,12 @@ <!-- title: "Export metrics to JSON document databases" description: "Archive your Agent's metrics to a JSON document database for long-term storage, further analysis, or correlation with data from other sources." -custom_edit_url: https://github.com/netdata/netdata/edit/master/exporting/json/README.md -sidebar_label: JSON Document Databases +custom_edit_url: "https://github.com/netdata/netdata/edit/master/exporting/json/README.md" +sidebar_label: "JSON Document Databases" +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Setup/Exporting connectors" +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> # Export metrics to JSON document databases diff --git a/exporting/mongodb/README.md b/exporting/mongodb/README.md index b10d547164..692fbed487 100644 --- a/exporting/mongodb/README.md +++ b/exporting/mongodb/README.md @@ -1,8 +1,12 @@ <!-- title: "Export metrics to MongoDB" description: "Archive your Agent's metrics to a MongoDB database for long-term storage, further analysis, or correlation with data from other sources." -custom_edit_url: https://github.com/netdata/netdata/edit/master/exporting/mongodb/README.md -sidebar_label: MongoDB +custom_edit_url: "https://github.com/netdata/netdata/edit/master/exporting/mongodb/README.md" +sidebar_label: "MongoDB" +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Setup/Exporting connectors" +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> # Export metrics to MongoDB diff --git a/exporting/opentsdb/README.md b/exporting/opentsdb/README.md index c9b1ab95a9..5eba6fc03e 100644 --- a/exporting/opentsdb/README.md +++ b/exporting/opentsdb/README.md @@ -1,8 +1,12 @@ <!-- title: "Export metrics to OpenTSDB" description: "Archive your Agent's metrics to an OpenTSDB database for long-term storage and further analysis." -custom_edit_url: https://github.com/netdata/netdata/edit/master/exporting/opentsdb/README.md -sidebar_label: OpenTSDB +custom_edit_url: "https://github.com/netdata/netdata/edit/master/exporting/opentsdb/README.md" +sidebar_label: "OpenTSDB" +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Setup/Exporting connectors" +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> # Export metrics to OpenTSDB diff --git a/exporting/prometheus/README.md b/exporting/prometheus/README.md index ae94867fae..4d8ff78a36 100644 --- a/exporting/prometheus/README.md +++ b/exporting/prometheus/README.md @@ -1,9 +1,14 @@ <!-- title: "Export metrics to Prometheus" description: "Export Netdata metrics to Prometheus for archiving and further analysis." -custom_edit_url: https://github.com/netdata/netdata/edit/master/exporting/prometheus/README.md +custom_edit_url: "https://github.com/netdata/netdata/edit/master/exporting/prometheus/README.md" sidebar_label: "Using Netdata with Prometheus" +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Setup/Exporting connectors" +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> + import { OneLineInstallWget, OneLineInstallCurl } from '@site/src/components/OneLineInstall/' # Using Netdata with Prometheus diff --git a/exporting/prometheus/remote_write/README.md b/exporting/prometheus/remote_write/README.md index 54c5d65881..22f91237fc 100644 --- a/exporting/prometheus/remote_write/README.md +++ b/exporting/prometheus/remote_write/README.md @@ -1,8 +1,11 @@ <!-- title: "Export metrics to Prometheus remote write providers" description: "Send Netdata metrics to your choice of more than 20 external storage providers for long-term archiving and further analysis." -custom_edit_url: https://github.com/netdata/netdata/edit/master/exporting/prometheus/remote_write/README.md -sidebar_label: Prometheus remote write +custom_edit_url: "https://github.com/netdata/netdata/edit/master/exporting/prometheus/remote_write/README.md" +sidebar_label: "Prometheus remote write" +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Setup/Exporting connectors" --> # Prometheus remote write exporting connector diff --git a/exporting/pubsub/README.md b/exporting/pubsub/README.md index 2f9ac83d44..10252f1675 100644 --- a/exporting/pubsub/README.md +++ b/exporting/pubsub/README.md @@ -1,8 +1,12 @@ <!-- title: "Export metrics to Google Cloud Pub/Sub Service" description: "Export Netdata metrics to the Google Cloud Pub/Sub Service for long-term archiving or analytical processing." -custom_edit_url: https://github.com/netdata/netdata/edit/master/exporting/pubsub/README.md -sidebar_label: Google Cloud Pub/Sub Service +custom_edit_url: "https://github.com/netdata/netdata/edit/master/exporting/pubsub/README.md" +sidebar_label: "Google Cloud Pub/Sub Service" +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Setup/Exporting connectors" +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> # Export metrics to Google Cloud Pub/Sub Service |