Skip to content

Open-source status page, incident response and uptime monitoring

πŸ“ docs (#852)

Thibault Le Ouay16e853451ae1
diff --git a/apps/docs/mint.json b/apps/docs/mint.json
index 6633c015d..bcbd892ac 100644
--- a/apps/docs/mint.json
+++ b/apps/docs/mint.json
@@ -107,7 +107,7 @@
},
{
"group": "Real User Monitoring",
- "pages": ["rum/overview"]
+ "pages": ["rum/overview", "rum/get-started"]
},
{
"group": "Developer Tools",
diff --git a/apps/docs/rum/get-started.mdx b/apps/docs/rum/get-started.mdx
new file mode 100644
index 000000000..8d3feffcc
--- /dev/null
+++ b/apps/docs/rum/get-started.mdx
@@ -0,0 +1,46 @@
+---
+title: Get Started
+description: "How to start using OpenStatus' real user monitoring"
+---
+## Get Started πŸš€
+
+In order to start using OpenStatus' real user monitoring, you need to create an new application in your dashboard.
+
+It will generate a unique Data Source Name (DSN) that you will use to initialize the monitoring in your application.
+
+
+## Setup πŸ”§
+
+We currently only support NextJS applications, other frameworks are coming soon.
+
+To get started, you need to install our package in your application.
+
+```bash
+pnpm add @openstatus/next-monitoring -E
+```
+
+Then, you need to add the following snippet to your `layout.tsx` file:
+
+```tsx
+import { OpenStatusProvider } from "@openstatus/next-monitoring";
+
+export default function RootLayout({
+ children,
+}: Readonly<{
+ children: React.ReactNode;
+}>) {
+ return (
+ <html lang="en">
+ <body className={inter.className}>
+ <OpenStatusProvider dsn="YOUR_DSN" />
+ {children}
+ </body>
+ </html>
+ );
+}
+```
+
+
+What is `YOUR_DSN`? It's your unique Data Source Name that you can find in your OpenStatus dashboard.
+
+
diff --git a/apps/docs/rum/overview.mdx b/apps/docs/rum/overview.mdx
index 4de5b6471..2f2ff2da1 100644
--- a/apps/docs/rum/overview.mdx
+++ b/apps/docs/rum/overview.mdx
@@ -19,33 +19,3 @@ We are currently tracking the following metrics:
- **CLS**: Cumulative Layout Shift
- **INP**: Interaction to Next Paint
-## Get started πŸš€
-
-We currently only support NextJS applications, other frameworks are coming soon.
-
-To get started, you need to install our package in your application.
-
-```bash
-pnpm add @openstatus/next-monitoring -E
-```
-
-Then, you need to add the following snippet to your `layout.tsx` file:
-
-```tsx
-import { OpenStatusProvider } from "@openstatus/next-monitoring";
-
-export default function RootLayout({
- children,
-}: Readonly<{
- children: React.ReactNode;
-}>) {
- return (
- <html lang="en">
- <body className={inter.className}>
- <OpenStatusProvider dsn="YOUR_DSN" />
- {children}
- </body>
- </html>
- );
-}
-```
diff --git a/apps/docs/synthetic/features/monitor.mdx b/apps/docs/synthetic/features/monitor.mdx
index dbdfe6515..5d068e815 100644
--- a/apps/docs/synthetic/features/monitor.mdx
+++ b/apps/docs/synthetic/features/monitor.mdx
@@ -8,6 +8,9 @@ description: "How to create your first monitor with OpenStatus.dev"
A monitor is a job that runs periodically and checks the status of a service. It
can be a website, an API, or anything else that can be checked automatically.
+We will make a request to your endpoint on a regular schedule and record.
+
+
## Configure your monitor πŸ› 
Your endpoint check requires:
diff --git a/apps/docs/synthetic/features/status-page-subscribers.mdx b/apps/docs/synthetic/features/status-page-subscribers.mdx
index a4c9e09be..8f6f7919b 100644
--- a/apps/docs/synthetic/features/status-page-subscribers.mdx
+++ b/apps/docs/synthetic/features/status-page-subscribers.mdx
@@ -2,5 +2,16 @@
title: Status Page Subscribers
---
-If you are on a paid plan. Your status page will have a subscribers section.
-This section will allow your users to subscribe to your status page update.
+<Note>This is a paid feature only</Note>
+
+## What does it mean to subscribe to a status page?
+
+Your subscribers will receive an email notification when you update your status page. Each time you create a new status report or update an existing one, your subscribers will receive an email.
+
+As a status page owner you will be able to see the list of subscribers.
+
+## How to subscribe to a status page?
+
+To subscribe to a status page, you need to click on the `Subscribe` button on the status page.
+
+You will be asked to enter your email address. You will receive a confirmation email to validate your subscription.
\ No newline at end of file
diff --git a/apps/docs/synthetic/overview.mdx b/apps/docs/synthetic/overview.mdx
index e70e498d6..73fd71a1b 100644
--- a/apps/docs/synthetic/overview.mdx
+++ b/apps/docs/synthetic/overview.mdx
@@ -3,12 +3,16 @@ title: Overview
description: "How does OpenStatus' synthetic monitoring work?"
---
-With our synthetic monitoring, you can monitor the availability and performance of
-your website or API from various global locations.
+With synthetic monitoring, you can simulated requests to monitor the availability and performance of
+your website or API from various locations around the world.
-We will monitor your website or API on a regular schedule and record the
+We will make a request to your website or API on a regular schedule and record the
responses.
+We will alert you if your website or API is down, slow or does not return the expected response.
+
+You can create monitors in our dashboard, with the API or with Terraform.
+
## Locations 🌍
We currently support 6 regions:
@@ -22,9 +26,13 @@ We currently support 6 regions:
## Status Page πŸ“ƒ
-You can create a status page to display the availability and performance of your
-monitor to your users.
+Status page are a great way to communicate with your users when your website or API is down.
+
+You can create a status page to display the availability and the performance of your
+monitors to your users.
## Alerting 🚨
-You can configure alerts to be notified when your monitor is down or slow.
+Don't wait for your users to tell you that your website or API is down.
+
+You can configure alerts to be notified when your monitor is down or slow, or does not return the expected response.