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 /health | |
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 'health')
29 files changed, 167 insertions, 30 deletions
diff --git a/health/REFERENCE.md b/health/REFERENCE.md index c92d697299..569266ef57 100644 --- a/health/REFERENCE.md +++ b/health/REFERENCE.md @@ -1,6 +1,10 @@ <!-- title: "Health configuration reference" -custom_edit_url: https://github.com/netdata/netdata/edit/master/health/REFERENCE.md +sidebar_label: "Health" +custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/REFERENCE.md" +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Operations" --> # Health configuration reference diff --git a/health/notifications/README.md b/health/notifications/README.md index 0bd6c7649e..3398558363 100644 --- a/health/notifications/README.md +++ b/health/notifications/README.md @@ -1,7 +1,11 @@ <!-- title: "Alarm notifications" description: "Reference documentation for Netdata's alarm notification feature, which supports dozens of endpoints, user roles, and more." -custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/README.md +custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/README.md" +sidebar_label: "Notifications Reference" +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Operations" --> # Alarm notifications diff --git a/health/notifications/alerta/README.md b/health/notifications/alerta/README.md index 9603aae01f..5ecf55eea7 100644 --- a/health/notifications/alerta/README.md +++ b/health/notifications/alerta/README.md @@ -1,7 +1,12 @@ <!-- title: "alerta.io" +sidebar_label: "Alerta" description: "Send alarm notifications to Alerta to see the latest health status updates from multiple nodes in a single interface." -custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/alerta/README.md +custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/alerta/README.md" +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Setup/Notification/Agent" +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> # alerta.io diff --git a/health/notifications/awssns/README.md b/health/notifications/awssns/README.md index fc4a665e90..97768399e6 100644 --- a/health/notifications/awssns/README.md +++ b/health/notifications/awssns/README.md @@ -1,7 +1,12 @@ <!-- title: "Amazon SNS" +sidebar_label: "Amazon SNS" description: "hello" -custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/awssns/README.md +custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/awssns/README.md" +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Setup/Notification/Agent" +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> # Amazon SNS diff --git a/health/notifications/custom/README.md b/health/notifications/custom/README.md index edc42623d5..525503339b 100644 --- a/health/notifications/custom/README.md +++ b/health/notifications/custom/README.md @@ -1,6 +1,11 @@ <!-- title: "Custom" -custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/custom/README.md +sidebar_label: "Custom endpoint" +custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/custom/README.md" +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Setup/Notification/Agent" +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> # Custom diff --git a/health/notifications/discord/README.md b/health/notifications/discord/README.md index 568d03bc33..95c6a294e4 100644 --- a/health/notifications/discord/README.md +++ b/health/notifications/discord/README.md @@ -1,6 +1,11 @@ <!-- title: "Discordapp.com" -custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/discord/README.md +sidebar_label: "Discord" +custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/discord/README.md" +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Setup/Notification/Agent" +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> # Discordapp.com diff --git a/health/notifications/dynatrace/README.md b/health/notifications/dynatrace/README.md index 3f8ad85b6d..a36683933f 100644 --- a/health/notifications/dynatrace/README.md +++ b/health/notifications/dynatrace/README.md @@ -1,6 +1,11 @@ <!-- title: "Dynatrace" -custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/dynatrace/README.md +sidebar_label: "Dynatrace Events" +custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/dynatrace/README.md" +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Setup/Notification/Agent" +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> # Dynatrace diff --git a/health/notifications/email/README.md b/health/notifications/email/README.md index 3dc84dd408..01dfd0e6ff 100644 --- a/health/notifications/email/README.md +++ b/health/notifications/email/README.md @@ -1,6 +1,11 @@ <!-- title: "Email" -custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/email/README.md +sidebar_label: "Email" +custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/email/README.md" +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Setup/Notification/Agent" +learn_autogeneration_metadata: "{'part_of_cloud': True, 'part_of_agent': True}" --> # Email diff --git a/health/notifications/flock/README.md b/health/notifications/flock/README.md index b9e0025b31..175f8a4661 100644 --- a/health/notifications/flock/README.md +++ b/health/notifications/flock/README.md @@ -1,6 +1,11 @@ <!-- title: "Flock" -custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/flock/README.md +sidebar_label: "Flock" +custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/flock/README.md" +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Setup/Notification/Agent" +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> # Flock diff --git a/health/notifications/gotify/README.md b/health/notifications/gotify/README.md index c253c845c7..e6158ccd56 100644 --- a/health/notifications/gotify/README.md +++ b/health/notifications/gotify/README.md @@ -3,6 +3,10 @@ title: "Send notifications to Gotify" description: "Send alerts to your Gotify instance when an alert gets triggered in Netdata." sidebar_label: "Gotify" custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/gotify/README.md +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Setup/Notification/Agent" +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> # Send notifications to Gotify diff --git a/health/notifications/hangouts/README.md b/health/notifications/hangouts/README.md index 7554b39cd9..45da1bfa0b 100644 --- a/health/notifications/hangouts/README.md +++ b/health/notifications/hangouts/README.md @@ -2,7 +2,11 @@ title: "Send notifications to Google Hangouts" description: "Send alerts to Send notifications to Google Hangouts any time an anomaly or performance issue strikes a node in your infrastructure." sidebar_label: "Google Hangouts" -custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/hangouts/README.md +custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/hangouts/README.md" +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Setup/Notification/Agent" +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> # Send notifications to Google Hangouts diff --git a/health/notifications/irc/README.md b/health/notifications/irc/README.md index 21c998d11b..a4877f48a5 100644 --- a/health/notifications/irc/README.md +++ b/health/notifications/irc/README.md @@ -1,6 +1,11 @@ <!-- title: "IRC" -custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/irc/README.md +sidebar_label: "IRC" +custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/irc/README.md" +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Setup/Notification/Agent" +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> # IRC diff --git a/health/notifications/kavenegar/README.md b/health/notifications/kavenegar/README.md index 6123eb9013..443fcdba46 100644 --- a/health/notifications/kavenegar/README.md +++ b/health/notifications/kavenegar/README.md @@ -1,6 +1,11 @@ <!-- title: "Kavenegar" -custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/kavenegar/README.md +sidebar_label: "Kavenegar" +custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/kavenegar/README.md" +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Setup/Notification/Agent" +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> # Kavenegar diff --git a/health/notifications/matrix/README.md b/health/notifications/matrix/README.md index 8eeecf55d3..80e22da37e 100644 --- a/health/notifications/matrix/README.md +++ b/health/notifications/matrix/README.md @@ -2,7 +2,11 @@ title: "Send Netdata notifications to Matrix network rooms" description: "Stay aware of warning or critical anomalies by sending health alarms to Matrix network rooms with Netdata's health monitoring watchdog." sidebar_label: "Matrix" -custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/matrix/README.md +custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/matrix/README.md" +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Setup/Notification/Agent" +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> # Matrix diff --git a/health/notifications/messagebird/README.md b/health/notifications/messagebird/README.md index f70e86c68a..0143019851 100644 --- a/health/notifications/messagebird/README.md +++ b/health/notifications/messagebird/README.md @@ -1,6 +1,11 @@ <!-- title: "Messagebird" -custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/messagebird/README.md +sidebar_label: "Messagebird" +custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/messagebird/README.md" +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Setup/Notification/Agent" +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> # Messagebird diff --git a/health/notifications/msteams/README.md b/health/notifications/msteams/README.md index c9a13bac92..75e652a72b 100644 --- a/health/notifications/msteams/README.md +++ b/health/notifications/msteams/README.md @@ -1,6 +1,11 @@ <!-- title: "Microsoft Teams" -custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/msteams/README.md +sidebar_label: "Microsoft Teams" +custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/msteams/README.md" +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Setup/Notification/Agent" +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> # Microsoft Teams diff --git a/health/notifications/opsgenie/README.md b/health/notifications/opsgenie/README.md index 640fcd42ac..2ee353003f 100644 --- a/health/notifications/opsgenie/README.md +++ b/health/notifications/opsgenie/README.md @@ -2,7 +2,11 @@ title: "Send notifications to Opsgenie" description: "Send alerts to your Opsgenie incident response account any time an anomaly or performance issue strikes a node in your infrastructure." sidebar_label: "Opsgenie" -custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/opsgenie/README.md +custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/opsgenie/README.md" +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Setup/Notification/Agent" +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> # Send notifications to Opsgenie diff --git a/health/notifications/pagerduty/README.md b/health/notifications/pagerduty/README.md index 30db6379cc..f52578cf38 100644 --- a/health/notifications/pagerduty/README.md +++ b/health/notifications/pagerduty/README.md @@ -2,7 +2,11 @@ title: "Send alert notifications to PagerDuty" description: "Send alerts to your PagerDuty dashboard any time an anomaly or performance issue strikes a node in your infrastructure." sidebar_label: "PagerDuty" -custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/pagerduty/README.md +custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/pagerduty/README.md" +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Setup/Notification/Agent" +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> # Send alert notifications to PagerDuty diff --git a/health/notifications/prowl/README.md b/health/notifications/prowl/README.md index dc136820ce..8656c13146 100644 --- a/health/notifications/prowl/README.md +++ b/health/notifications/prowl/README.md @@ -1,6 +1,11 @@ <!-- title: "Prowl" -custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/prowl/README.md +sidebar_label: "Prowl" +custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/prowl/README.md" +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Setup/Notification/Agent" +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> # Prowl diff --git a/health/notifications/pushbullet/README.md b/health/notifications/pushbullet/README.md index 194050bc13..17ed936461 100644 --- a/health/notifications/pushbullet/README.md +++ b/health/notifications/pushbullet/README.md @@ -1,6 +1,11 @@ <!-- title: "PushBullet" -custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/pushbullet/README.md +sidebar_label: "PushBullet" +custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/pushbullet/README.md" +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Setup/Notification/Agent" +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> # PushBullet diff --git a/health/notifications/pushover/README.md b/health/notifications/pushover/README.md index 1e50f7140d..4d5ea5a96d 100644 --- a/health/notifications/pushover/README.md +++ b/health/notifications/pushover/README.md @@ -1,6 +1,11 @@ <!-- title: "PushOver" -custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/pushover/README.md +sidebar_label: "PushOver" +custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/pushover/README.md" +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Setup/Notification/Agent" +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> # PushOver diff --git a/health/notifications/rocketchat/README.md b/health/notifications/rocketchat/README.md index 96d6160b2d..0f7867d0f5 100644 --- a/health/notifications/rocketchat/README.md +++ b/health/notifications/rocketchat/README.md @@ -1,6 +1,11 @@ <!-- title: "Rocket.Chat" -custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/rocketchat/README.md +sidebar_label: "Rocket Chat" +custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/rocketchat/README.md" +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Setup/Notification/Agent" +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> # Rocket.Chat diff --git a/health/notifications/slack/README.md b/health/notifications/slack/README.md index ad36ce34aa..ad9a213460 100644 --- a/health/notifications/slack/README.md +++ b/health/notifications/slack/README.md @@ -1,6 +1,11 @@ <!-- title: "Slack" -custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/slack/README.md +sidebar_label: "Slack" +custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/slack/README.md" +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Setup/Notification/Agent" +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> # Slack diff --git a/health/notifications/smstools3/README.md b/health/notifications/smstools3/README.md index 6618dfa180..9535c9549c 100644 --- a/health/notifications/smstools3/README.md +++ b/health/notifications/smstools3/README.md @@ -1,6 +1,11 @@ <!-- title: "SMS Server Tools 3" -custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/smstools3/README.md +sidebar_label: "SMS server" +custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/smstools3/README.md" +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Setup/Notification/Agent" +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> # SMS Server Tools 3 diff --git a/health/notifications/stackpulse/README.md b/health/notifications/stackpulse/README.md index c478fd5848..da2a084a71 100644 --- a/health/notifications/stackpulse/README.md +++ b/health/notifications/stackpulse/README.md @@ -2,7 +2,11 @@ title: "Send notifications to StackPulse" description: "Send alerts to your StackPulse Netdata integration any time an anomaly or performance issue strikes a node in your infrastructure." sidebar_label: "StackPulse" -custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/stackpulse/README.md +custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/stackpulse/README.md" +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Setup/Notification/Agent" +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> # Send notifications to StackPulse diff --git a/health/notifications/syslog/README.md b/health/notifications/syslog/README.md index 8b7863a1a0..3527decc46 100644 --- a/health/notifications/syslog/README.md +++ b/health/notifications/syslog/README.md @@ -1,6 +1,11 @@ <!-- title: "Syslog" -custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/syslog/README.md +sidebar_label: "Syslog" +custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/syslog/README.md" +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Setup/Notification/Agent" +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> # Syslog diff --git a/health/notifications/telegram/README.md b/health/notifications/telegram/README.md index 2a2ed56232..f80a2838db 100644 --- a/health/notifications/telegram/README.md +++ b/health/notifications/telegram/README.md @@ -1,6 +1,11 @@ <!-- title: "Telegram" -custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/telegram/README.md +sidebar_label: "Telegram" +custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/telegram/README.md" +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Setup/Notification/Agent" +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> # Telegram diff --git a/health/notifications/twilio/README.md b/health/notifications/twilio/README.md index b563c66c1c..470b2413b5 100644 --- a/health/notifications/twilio/README.md +++ b/health/notifications/twilio/README.md @@ -1,6 +1,11 @@ <!-- title: "Twilio" -custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/twilio/README.md +sidebar_label: "Twilio" +custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/twilio/README.md" +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Setup/Notification/Agent" +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> # Twilio diff --git a/health/notifications/web/README.md b/health/notifications/web/README.md index 185843af55..b4afd9ea78 100644 --- a/health/notifications/web/README.md +++ b/health/notifications/web/README.md @@ -1,9 +1,14 @@ <!-- -title: "Dashboard" -custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/web/README.md +title: "Pop up" +sidebar_label: "Pop up notifications" +custom_edit_url: "https://github.com/netdata/netdata/edit/master/health/notifications/web/README.md" +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Setup/Notification/Agent" +learn_autogeneration_metadata: "{'part_of_cloud': False, 'part_of_agent': True}" --> -# Dashboard +# Pop up notifications The Netdata dashboard shows HTML notifications, when it is open. |