Skip to content

Open-source status page, incident response and uptime monitoring

Improve doc (#429)

Thibault Le Ouayc4aef26417b2
diff --git a/apps/docs/pages/_meta.json b/apps/docs/pages/_meta.json
index 6e52ae7a7..a55477f9c 100644
--- a/apps/docs/pages/_meta.json
+++ b/apps/docs/pages/_meta.json
@@ -2,9 +2,9 @@
"index": "What is OpenStatus?",
"getting-started": "Getting started",
"integrations": "Integrations",
- "developer-guide": "Developer guide",
- "api-server": "API",
- "packages": "Packages",
+ "incident-automation": "Incident automation",
+ "developper-guide": "Developer guide",
+ "rest-api": "API",
"contact": {
"title": "🌐 Website",
"type": "page",
diff --git a/apps/docs/pages/incident-automation/_meta.json b/apps/docs/pages/incident-automation/_meta.json
new file mode 100644
index 000000000..f1bce748a
--- /dev/null
+++ b/apps/docs/pages/incident-automation/_meta.json
@@ -0,0 +1,3 @@
+{
+ "get-started": "Get started"
+}
diff --git a/apps/docs/pages/incident-automation/get-started.mdx b/apps/docs/pages/incident-automation/get-started.mdx
new file mode 100644
index 000000000..d1934a7fe
--- /dev/null
+++ b/apps/docs/pages/incident-automation/get-started.mdx
@@ -0,0 +1,11 @@
+# What is incident automation? πŸ€”
+
+When you have an incident, you might need to perform a series of actions to
+handle it. For example, you might need to:
+
+- create a slack channel
+- create a google meet meeting
+- create a Linear ticket
+- Perform a checklist of actions
+
+Incident automation allows you to automate these actions.
diff --git a/apps/docs/pages/integrations/_meta.json b/apps/docs/pages/integrations/_meta.json
index eb3f7fc4d..4514dfbc0 100644
--- a/apps/docs/pages/integrations/_meta.json
+++ b/apps/docs/pages/integrations/_meta.json
@@ -1,10 +1,5 @@
{
"discord": "Discord",
- "fly": "Fly.io",
- "phone-call": "Phone Call",
- "otel": "OpenTelemetry",
- "sms": "SMS",
"slack": "Slack",
- "telegram": "Telegram",
- "vercel": "Vercel"
+ "telegram": "Telegram"
}
diff --git a/apps/docs/pages/integrations/discord.mdx b/apps/docs/pages/integrations/discord.mdx
index 0aaf1c58d..344e8f998 100644
--- a/apps/docs/pages/integrations/discord.mdx
+++ b/apps/docs/pages/integrations/discord.mdx
@@ -1,3 +1,6 @@
# Discord
-🚧 Coming soon 🚧
+When a monitor is down you can set up a webhook to send a message to a Discord
+channel. You can set up a webhook in the Discord settings. The webhook URL
+should look something like this:
+`https://discordapp.com/api/webhooks/123456789012345678/abcdefghijklmnopqrstuvwxyz1234567890`
diff --git a/apps/docs/pages/integrations/fly.mdx b/apps/docs/pages/integrations/fly.mdx
deleted file mode 100644
index eefd9976f..000000000
--- a/apps/docs/pages/integrations/fly.mdx
+++ /dev/null
@@ -1,3 +0,0 @@
-# Fly.io
-
-🚧 Coming soon 🚧
diff --git a/apps/docs/pages/integrations/slack.mdx b/apps/docs/pages/integrations/slack.mdx
index a6317687d..61affd4a2 100644
--- a/apps/docs/pages/integrations/slack.mdx
+++ b/apps/docs/pages/integrations/slack.mdx
@@ -1,3 +1,5 @@
# Slack
-🚧 Coming soon 🚧
+When a monitor is down, a message can be sent to a Slack channel. To enable this
+feature, you need to create a Slack webhook. You can do this by following the
+instructions [here](https://api.slack.com/incoming-webhooks).
diff --git a/apps/docs/pages/integrations/vercel.mdx b/apps/docs/pages/integrations/vercel.mdx
deleted file mode 100644
index c19b3f69f..000000000
--- a/apps/docs/pages/integrations/vercel.mdx
+++ /dev/null
@@ -1,3 +0,0 @@
-# Vercel
-
-🚧 Coming soon 🚧