Skip to content

Open-source status page, incident response and uptime monitoring

docs: update getting started (#452)

Maximilian Kaske64ced46fc36b
diff --git a/apps/docs/getting-started/alerting.mdx b/apps/docs/getting-started/alerting.mdx
deleted file mode 100644
index 090d3bd11..000000000
--- a/apps/docs/getting-started/alerting.mdx
+++ /dev/null
@@ -1,12 +0,0 @@
----
-title: Alert
-description: "How to create your first alert with OpenStatus.dev"
----
-
-## What is an alert? 🚨
-
-An alert is a notification that is sent to you when a condition is met. For
-instance, you can set up an alert to notify you when your website monitor fails
-to ping your website.
-
-## Configure your alert πŸ› 
diff --git a/apps/docs/getting-started/incident.mdx b/apps/docs/getting-started/incident.mdx
new file mode 100644
index 000000000..c39e334f7
--- /dev/null
+++ b/apps/docs/getting-started/incident.mdx
@@ -0,0 +1,12 @@
+---
+title: Incident
+description: "How to create your first incident πŸ”₯"
+---
+
+When creating an incident, you can map it to either to a **status page** or to a
+**monitor**. This will allow you access the latest incidents on your status
+page.
+
+Update your incident over time and keep your users informed. Add a new
+**status**, **date** and **message** to your incident. They will be displayed on
+a timeline.
diff --git a/apps/docs/getting-started/monitor.mdx b/apps/docs/getting-started/monitor.mdx
index b4cdfb79c..972e9b6c5 100644
--- a/apps/docs/getting-started/monitor.mdx
+++ b/apps/docs/getting-started/monitor.mdx
@@ -10,23 +10,57 @@ can be a website, an API, or anything else that can be checked automatically.
## Configure your monitor πŸ› 
-<Frame caption="Create your first monitor">
- <img src="/images/monitor/monitor.png" alt="Create your first monitor" />
+Your endpoint check requires:
+
+- a **name** to identify your monitor
+- the **URL** to checked
+
+We will store the **response time** and the **status code** of your endpoint.
+
+<Frame caption="Monitor your endpoint">
+ <img
+ src="/images/monitor/monitor-detail.png"
+ alt="Charts with status code and response time"
+ />
</Frame>
-A monitor requires a few things to be configured:
+### HTTP Request πŸ“€
+
+Customize the request sent to your endpoint.
+
+Choose between one of the request **HTTP Method**: `GET` (default), `POST` or
+`HEAD`.
+
+Add custom key-value **HTTP Headers** to your request.
+
+> OpenStatus automatically appends the `"OpenStatus-Ping": "true"` header to
+> your request. This header is used to identify the request as a ping request
+> and can be exluded from your analytics.
-- an endpoint to check πŸ”—
-- a check interval ⏰
-- a region to run the check from 🌍
+If you select the `POST` method, you can add a custom **HTTP Body** to your
+request.
-## Advanced configuration πŸ§™β€β™‚οΈ
+### Advanced Configuration ⏱️
-Sometimes you need to configure your monitor more precisely.
+Define the **frequency** of your checks. You can choose between: `1m`, `5m`,
+`10m` (default), `30min` or `1h`.
-- set a Method (GET, POST) 🧭
-- set a custom HTTP Headers (useful if your endpoint is secured) πŸ”‘
-- set a custom HTTP Body (for POST request only) πŸ“¦
+By default, **all regions** are enabled. You can disable some regions if you
+want to. Leaving it empty will check your endpoint from a random region.
+
+The **description** is optional. If defined, an `Info` tooltip will be added to
+your monitor name.
+
+You can always pause your monitor with the **active** switch button.
+
+### Notifications πŸ””
+
+Get informed whenever a check fails. You can add multiple notification channels.
+
+We send a webhook to Slack or Discord channels. Or you can also receive an
+email.
+
+---
> Create an API key and use it in your HTTP Headers to create your monitor
> programmatically API.
diff --git a/apps/docs/getting-started/notification.mdx b/apps/docs/getting-started/notification.mdx
new file mode 100644
index 000000000..1c3a4b1c4
--- /dev/null
+++ b/apps/docs/getting-started/notification.mdx
@@ -0,0 +1,33 @@
+---
+title: Notification
+description: "How to create your first alert with OpenStatus.dev"
+---
+
+You get notified when your monitor has failed. Configure multiple alerts for
+each monitor.
+
+We support the following notification channels: **email**, **slack** and
+**discord**.
+
+<Frame caption="Create your notification channel">
+ <img
+ src="/images/notification/discord-notification.png"
+ alt="Create your notification bot"
+ />
+</Frame>
+
+### Email βœ‰οΈ
+
+Enter your email address in the alert configuration.
+
+### Slack πŸ“£
+
+Create an [incoming webhook](https://api.slack.com/messaging/webhooks) in your
+Slack workspace. Copy the webhook URL and paste it in the alert configuration.
+
+### Discord πŸ€–
+
+Create a
+[webhook](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks)
+in your Discord server. Copy the webhook URL and paste it in the alert
+configuration.
diff --git a/apps/docs/getting-started/status-widget.mdx b/apps/docs/getting-started/status-widget.mdx
index 218f4cafb..70887999c 100644
--- a/apps/docs/getting-started/status-widget.mdx
+++ b/apps/docs/getting-started/status-widget.mdx
@@ -2,8 +2,6 @@
title: Public Status Widget
---
-# Public Status Widget
-
We have added a public endpoint where you can access the status of your status
page. To access it, you only need the unique `:slug` you have chosen for your
page.
diff --git a/apps/docs/images/monitor/monitor-detail.png b/apps/docs/images/monitor/monitor-detail.png
new file mode 100644
index 000000000..2ba4b2a26
Binary files /dev/null and b/apps/docs/images/monitor/monitor-detail.png differ
diff --git a/apps/docs/images/notification/discord-notification.png b/apps/docs/images/notification/discord-notification.png
new file mode 100644
index 000000000..850c8a848
Binary files /dev/null and b/apps/docs/images/notification/discord-notification.png differ
diff --git a/apps/docs/introduction.mdx b/apps/docs/introduction.mdx
index 98be2eea8..b17e79b90 100644
--- a/apps/docs/introduction.mdx
+++ b/apps/docs/introduction.mdx
@@ -25,16 +25,16 @@ There are three ways to get started with OpenStatus.
## Start with OpenStatus
<CardGroup cols={2}>
- <Card title="Alert" href="/getting-started/alerting">
- Learn how to set up alerting for your monitors
- </Card>
- <Card title="Heartbeat" href="/getting-started/heartbeat">
- Learn how to create your first heartbeat monitor
- </Card>
<Card title="Monitor" href="/getting-started/monitor">
Learn how to create your first monitor
</Card>
<Card title="Status Page" href="/getting-started/status-page">
Learn how to set up your status page
</Card>
+ <Card title="Notification" href="/getting-started/notification">
+ Learn how to set up alerting for your monitors
+ </Card>
+ <Card title="Incident" href="/getting-started/incident">
+ Learn how to create your first incident
+ </Card>
</CardGroup>
diff --git a/apps/docs/mint.json b/apps/docs/mint.json
index 425629cbd..8e9a16893 100644
--- a/apps/docs/mint.json
+++ b/apps/docs/mint.json
@@ -71,10 +71,11 @@
{
"group": "Getting Started",
"pages": [
- "getting-started/alerting",
- "getting-started/heartbeat",
"getting-started/monitor",
- "getting-started/status-page"
+ "getting-started/status-page",
+ "getting-started/incident",
+ "getting-started/notification",
+ "getting-started/heartbeat"
]
},
"getting-started/status-widget"
diff --git a/packages/react/README.md b/packages/react/README.md
index 1c2c33e03..06d13526d 100644
--- a/packages/react/README.md
+++ b/packages/react/README.md
@@ -1,11 +1,11 @@
-## Status Widget
+# Status Widget
Create an account on [openstatus.dev](https://openstatus.dev), start monitoring
your endpoints and include your own StatusWidget into your React Application.
![Image of StatusWidget on openstatus.dev](https://openstatus.dev/assets/changelog/status-widget.png)
-### Install
+## Install
```bash
npm install @openstatus/react
@@ -14,9 +14,9 @@ yarn add @openstatus/react
bun add @openstatus/react
```
-### How to use the StatusWidget in your Next.js App Router
+## How to use the StatusWidget in your Next.js App Router
-#### Include the styles.css
+### Include the styles.css
If you are using tailwind, extend your config with:
@@ -53,7 +53,7 @@ export function Page() {
}
```
-### Headless getStatus utility function
+## Headless getStatus utility function
If you would like to style it yourself, you can use the `getStatus` function to
access the type response of the api call to:
@@ -90,7 +90,7 @@ export type Status =
Learn more in the [docs](https://docs.openstatus.dev/packages/react).
-#### About OpenStatus
+### About OpenStatus
OpenStatus is an open source monitoring services with incident managements.