Open-source status page, incident response and uptime monitoring
TypeScript alertingincident-managementmcpmcp-servermonitoringmonitoring-as-codeobservabilityon-callopen-sourcesrestatus-pagestatuspagesynthetic-monitoringterraformtinybirdtursouptimeuptime-checkeruptime-monitor
π docs (#857)
Thibault Le Ouay3265afdfa4c4
diff --git a/apps/docs/api-reference/page/get-page:id.mdx b/apps/docs/api-reference/page/get-page-id.mdxsimilarity index 100%rename from apps/docs/api-reference/page/get-page:id.mdxrename to apps/docs/api-reference/page/get-page-id.mdxdiff --git a/apps/docs/help/support.mdx b/apps/docs/help/support.mdxnew file mode 100644index 000000000..c4212dabb--- /dev/null+++ b/apps/docs/help/support.mdx@@ -0,0 +1,10 @@+---+title: Support+description: "We're always here to help."+---++If you have any questions, feedback, or need help you can:+- Schedule a [call](https://cal.com/team/openstatus/30min) with us.+- Join our [Discord](https://www.openstatus.dev/discord) community.+- Send us an email at [[email protected]](mailto:[email protected])+- Open an issue on our [GitHub](https://www.github.com/openstatushq/openstatus) repository.\ No newline at end of filediff --git a/apps/docs/images/incident/incident-detail.png b/apps/docs/images/incident/incident-detail.pngnew file mode 100644index 000000000..392b810d4Binary files /dev/null and b/apps/docs/images/incident/incident-detail.png differdiff --git a/apps/docs/mint.json b/apps/docs/mint.jsonindex bcbd892ac..e87653edd 100644--- a/apps/docs/mint.json+++ b/apps/docs/mint.json@@ -80,7 +80,6 @@"group": "Features","pages": ["synthetic/features/incident",- "synthetic/features/heartbeat","synthetic/features/monitor",{"group": "Notifications",@@ -125,6 +124,10 @@"contributing/setup-env"]},+ {+ "group": "Help",+ "pages": ["help/support"]+ },{"group": "API Documentation","icon": "code",diff --git a/apps/docs/synthetic/features/heartbeat.mdx b/apps/docs/synthetic/features/heartbeat.mdxdeleted file mode 100644index c96de2403..000000000--- a/apps/docs/synthetic/features/heartbeat.mdx+++ /dev/null@@ -1,14 +0,0 @@-----title: Cron Monitor-description: "How to create your first cron monitor with OpenStatus.dev"------## What is a Cron Monitor? π€--A cron monitor allows you to monitor your cron jobs. You call your OpenStatus-endpoint at the end of your cron job. If we haven't received your call we will-trigger an alert and notify you.--## Configure your cron monitor π--π§ Coming soon π§diff --git a/apps/docs/synthetic/features/incident.mdx b/apps/docs/synthetic/features/incident.mdxindex 594e2d930..5df9c9c5f 100644--- a/apps/docs/synthetic/features/incident.mdx+++ b/apps/docs/synthetic/features/incident.mdx@@ -21,3 +21,19 @@ Go to the incident page and click on the resolve button.We automatically resolve an incident when the monitor is passing in more than50% of the locations.+++## Incident detail page++On the incident page, you can see the details of the incident, the monitor that failed, and the duration.+We are also taking a screenshot of the monitor when the incident is created, and when it's resolved.+++<Frame caption="Incident page detail">+ <img+ src="/images/incident/incident-detail.png"+ alt="Incident page"+ />+</Frame>++<Info>There might be a delay between the incident creation and the screenshot capture. Your endpoint could have already recovered.</Info>\ No newline at end of filediff --git a/apps/docs/synthetic/features/monitor.mdx b/apps/docs/synthetic/features/monitor.mdxindex 5d068e815..b94d15ce9 100644--- a/apps/docs/synthetic/features/monitor.mdx+++ b/apps/docs/synthetic/features/monitor.mdx@@ -10,6 +10,10 @@ 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.+If the check fails, a <a href="/synthetic/features/notification">notification</a> is sent and an <a href="/synthetic/features/incident">incident</a> is created.++<Info>If you are monitoring an endpoint you don't own (e.g google.com), your request might be blocked by the remote server.</Info>+## Configure your monitor π@@ -28,6 +32,7 @@ returned, and the **timing metrics** of your endpoint./></Frame>+### HTTP Request π€Customize the request sent to your endpoint.@@ -41,6 +46,8 @@ Add custom key-value **HTTP Headers** to your request.> your request. This header is used to identify the request as a ping request> and can be exluded from your analytics.++If you select the `POST` method, you can add a custom **HTTP Body** to yourrequest.diff --git a/packages/emails/emails/welcome.tsx b/packages/emails/emails/welcome.tsxindex a2037f43a..32e229977 100644--- a/packages/emails/emails/welcome.tsx+++ b/packages/emails/emails/welcome.tsx@@ -4,7 +4,7 @@ const WelcomeEmail = () => {return (<Html><Head>- <title>Level up your website and API monitoring.</title>+ <title>Welcome to OpenStatus</title><Preview>Take the most of your OpenStatus monitoring</Preview><Body>Hey π@@ -26,7 +26,9 @@ const WelcomeEmail = () => {</a>{" "}to manage your monitors<br />- Integrate your status within your application with our{" "}- <a href="https://docs.openstatus.dev/packages/status-widget">API</a>{" "}+ <a href="https://docs.openstatus.dev/packages/status-widget">+ API+ </a>{" "}and{" "}<a href="https://docs.openstatus.dev/packages/react">React Widget</a><br />- Build your own status page with our{" "}@@ -38,7 +40,8 @@ const WelcomeEmail = () => {that you can easily host on CloudFlare<br /><br />- If you have any questions, just let me know.+ If you have any questions, just let me know, or book a call with me{" "}+ <a href="https://cal.com/team/openstatus/30min">here</a>.<br />Thank you,<br />@@ -47,7 +50,8 @@ const WelcomeEmail = () => {<br /><br />β Star us on{" "}<Link href="https://github.com/openstatushq/openstatus">GitHub</Link>- <br />π Visit our website{" "}+ <br />+ π Visit our website{" "}<Link href="https://www.openstatus.dev">OpenStatus.dev</Link></Body></Head>