Open-source status page, incident response and uptime monitoring
TypeScript alertingincident-managementmcpmcp-servermonitoringmonitoring-as-codeobservabilityon-callopen-sourcesrestatus-pagestatuspagesynthetic-monitoringterraformtinybirdtursouptimeuptime-checkeruptime-monitor
π Docs few improvements (#1106)
Thibault Le Ouay42e6ad129abe
diff --git a/apps/docs/astro.config.mjs b/apps/docs/astro.config.mjsindex 21d81e669..4f5b20428 100644--- a/apps/docs/astro.config.mjs+++ b/apps/docs/astro.config.mjs@@ -15,7 +15,7 @@ export default defineConfig({integrations: [sitemap(),starlight({- title: "OpenStatus Docs",+ title: "OpenStatus Documentation",favicon: "/favicon.ico",social: {github: "https://github.com/openstatusHQ/openstatus",@@ -103,6 +103,10 @@ export default defineConfig({items: [{ label: "Overview", slug: "status-page/overview" },+ {+ label: "Create your status page",+ slug: "status-page/create-status-page",+ },{ label: "Reports", slug: "status-page/reports" },{ label: "Maintenances", slug: "status-page/maintenances" },{ label: "Widget", slug: "status-page/widget" },@@ -116,6 +120,11 @@ export default defineConfig({autogenerate: { directory: "status-page/customization" },collapsed: true,},+ {+ label: "Advanced",+ autogenerate: { directory: "status-page/advanced" },+ collapsed: true,+ },],},{ label: "Incidents", autogenerate: { directory: "incident" } },@@ -142,6 +151,7 @@ export default defineConfig({{label: "Help",slug: "help/support",+ collapsed: true,},],},diff --git a/apps/docs/src/assets/status-page/status-page.png b/apps/docs/src/assets/status-page/status-page.pngnew file mode 100644index 000000000..0fbd18e5bBinary files /dev/null and b/apps/docs/src/assets/status-page/status-page.png differdiff --git a/apps/docs/src/content/docs/getting-started/introduction.mdx b/apps/docs/src/content/docs/getting-started/introduction.mdxindex fe0c3123d..02c04c7d8 100644--- a/apps/docs/src/content/docs/getting-started/introduction.mdx+++ b/apps/docs/src/content/docs/getting-started/introduction.mdx@@ -1,6 +1,6 @@---title: Getting Started-description: "What is OpenStatus.dev and how to get started"+description: "How to get started with OpenStatus?"topic: docsnext: 'Start Monitoring'---@@ -8,14 +8,20 @@ next: 'Start Monitoring'import { Aside } from '@astrojs/starlight/components';-## What is OpenStatus π§βπ«+## How to get started with OpenStatus?-[OpenStatus](https://www.openstatus.dev) is an open-source synthetic monitoring platform. It allows you to monitor your services and get notified when they are down.+You can either use the cloud version of OpenStatus or self-host it.-## How to get started π+### Cloud version-You can either use the hosted version of OpenStatus or self-host it.+You can (sign up)[https://www.openstatus.dev/app/login?ref=docs] for a free account and start monitoring your services in seconds.++### Hosted version++All our code is open-source and you can host it on your own infrastructure.++We are working on a lightweight version of OpenStatus that you can self-host easily.<Aside>It is not easy to self-host OpenStatus on your own at the moment. We will be working on making it easier in the future.diff --git a/apps/docs/src/content/docs/index.mdx b/apps/docs/src/content/docs/index.mdxindex c65e11724..8c365174c 100644--- a/apps/docs/src/content/docs/index.mdx+++ b/apps/docs/src/content/docs/index.mdx@@ -1,17 +1,26 @@----title: Welcome+title: Documentationdescription: Explore our documentation to get started with OpenStatus.template: doctopic: docsnext: falsehero:- title: Welcome to OpenStatus Documentation+ title: Welcome to OpenStatustagline: Explore our documentation to get started with OpenStatus---import { Card, CardGrid, LinkCard } from '@astrojs/starlight/components';import "../../custom.css"+### What is OpenStatus?++[OpenStatus](https://www.openstatus.dev) is an open-source synthetic monitoring tool that helps you monitor the availability and performance of your website, API, servers from various locations around the world.++We also provide beautiful status pages to keep your users informed about the status of your services.++### New to OpenStatus?++<CardGrid ><Card title="Synthetic Monitoring" icon="open-book">Learn how to <a href="/monitoring/create-monitor">create</a> your first monitor with OpenStatus.@@ -31,7 +40,7 @@ import "../../custom.css"</CardGrid>-## Join the community+### Join the communityJoin the commmunity to get help, share your ideas or just to say hi.diff --git a/apps/docs/src/content/docs/monitoring/create-monitor.mdx b/apps/docs/src/content/docs/monitoring/create-monitor.mdxindex 641c8749f..953e7ccc0 100644--- a/apps/docs/src/content/docs/monitoring/create-monitor.mdx+++ b/apps/docs/src/content/docs/monitoring/create-monitor.mdx@@ -4,13 +4,14 @@ description: "How to create your first monitor with OpenStatus.dev"---import { Image } from 'astro:assets';-import { Aside } from '@astrojs/starlight/components';+import { Aside, CardGrid, LinkCard } from '@astrojs/starlight/components';import monitorDetail from '../../../assets/monitor/monitor-detail.png';import { ShowcaseYouTube } from 'starlight-showcases'+Go to the **Monitors** page and click on the **Create Monitor** button.-## Configure your monitor π+## Configure your monitorYour endpoint check requires:@@ -26,7 +27,7 @@ returned, and the **timing metrics** of your endpoint./>-### HTTP Request π€+### HTTP RequestCustomize the request sent to your endpoint.@@ -45,12 +46,40 @@ If you select the `POST` method, you can add a custom **HTTP Body** to yourrequest.-### Limitations β οΈ+++## Customization++You can customize your monitor with the following options:++<CardGrid>+ <LinkCard+ title="Assertions"+ href="/monitoring/customization/assertions"+ />+ <LinkCard+ title="Frequency"+ href="/monitoring/customization/frequency"+ />+ <LinkCard+ title="Regions"+ href="/monitoring/customization/regions"+ />+ <LinkCard+ title="Timing"+ href="/monitoring/customization/timing"+ />+</CardGrid>++++## Known Limitations<Aside>If you are monitoring an endpoint you don't own (e.g google.com), your request might be blocked by the remote server.</Aside>-## Video Tutorial πΊ++## Video Tutorial<ShowcaseYouTubeentries={[@@ -60,4 +89,4 @@ request.},]}-/>+/>\ No newline at end of filediff --git a/apps/docs/src/content/docs/monitoring/overview.mdx b/apps/docs/src/content/docs/monitoring/overview.mdxindex 6a9da61db..278283b5a 100644--- a/apps/docs/src/content/docs/monitoring/overview.mdx+++ b/apps/docs/src/content/docs/monitoring/overview.mdx@@ -13,34 +13,26 @@ responses.We will alert you if your website or API is down, is timing out or does not return the expected response.-You can create monitors in our dashboard, with the [API](https://api.openstatus.dev/v1#tag/monitor/POST/monitor) or with [Terraform](/tools/terraform).+You can create monitors in our dashboard, with the [API](https://api.openstatus.dev/v1#tag/monitor/POST/monitor) or with our [Terraform provider](/tools/terraform).-### What is a monitor? π§βπ«+### What is a monitor?A monitor is a job that runs periodically or on-demand and checks the status of a service. Itcan 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, or on-demand and record the results.+We will make a request to your endpoint and record the results.-### Quick Links+### Monitor types<CardGrid><LinkCard- title="Assertions"- href="/monitoring/customization/assertions"+ title="HTTP Monitor"+ href="/type/http"/><LinkCard- title="Frequency"- href="/monitoring/customization/frequency"- />- <LinkCard- title="Regions"- href="/monitoring/customization/regions"- />- <LinkCard- title="Timing"- href="/monitoring/customization/timing"+ title="TCP Monitor"+ href="/type/tcp"/></CardGrid>diff --git a/apps/docs/src/content/docs/status-page/advanced/badge.mdx b/apps/docs/src/content/docs/status-page/advanced/badge.mdxnew file mode 100644index 000000000..c57cfc55c--- /dev/null+++ b/apps/docs/src/content/docs/status-page/advanced/badge.mdx@@ -0,0 +1,34 @@+---+title: Status Page Badge+---++You can embed the status page badge on your website or GitHub README to show the+current status of your services.++<a href="https://status.openstatus.dev">+ <img src="https://status.openstatus.dev/badge" />+</a>++Copy the following code and paste it into your website or GitHub README:++```html+<img src="https://YOUR-SLUG.openstatus.dev/badge" />+```++If you want the dark version of the badge, you can use the following URL:++```html+<img src="https://YOUR-SLUG.openstatus.dev/badge?theme=dark" />+```++You can also customize the size of the badge by adding a `size` parameter:++- `sm`+- `md`+- `lg`+- `xl`+++```html+<img src="https://YOUR-SLUG.openstatus.dev/badge?theme=dark&size=xl" />+```\ No newline at end of filediff --git a/apps/docs/src/content/docs/status-page/create-status-page.mdx b/apps/docs/src/content/docs/status-page/create-status-page.mdxnew file mode 100644index 000000000..06af88845--- /dev/null+++ b/apps/docs/src/content/docs/status-page/create-status-page.mdx@@ -0,0 +1,16 @@+---+title: How to create a status page?+---++import { Image } from 'astro:assets';++import StatusPageEmpty from '../../../assets/status-page/status-page-empty.png';++When you create your first status page, you will see an empty page.++In order to create your status page, you need to create at least one monitor.++ <Image+ src={StatusPageEmpty}+ alt="Create your status page"+ />diff --git a/apps/docs/src/content/docs/status-page/overview.mdx b/apps/docs/src/content/docs/status-page/overview.mdxindex 1c9b0aa67..70ab1ea72 100644--- a/apps/docs/src/content/docs/status-page/overview.mdx+++ b/apps/docs/src/content/docs/status-page/overview.mdx@@ -1,60 +1,24 @@---title: Status page-description: "How to create your first status page π₯"----import { Image } from 'astro:assets';-import StatusPageEmpty from '../../../assets/status-page/status-page-empty.png';--When you create your first status page, you will see an empty page.--In order to create your status page, you need to create at least one monitor.+import StatusPage from '../../../assets/status-page/status-page.png';<Image- src={StatusPageEmpty}- alt="Create your status page"+ src={StatusPage}+ alt="OpenStatus status page"/>++## What is a status page π§βπ«A status page is a public page that displays the status and performance of yourservices. It shows the current status of your services and the history ofincidents.-## Status Page Badge π·οΈ--You can embed the status page badge on your website or GitHub README to show the-current status of your services.--<a href="https://status.openstatus.dev">- <img src="https://status.openstatus.dev/badge" />-</a>--Copy the following code and paste it into your website or GitHub README:--```html-<img src="https://YOUR-SLUG.openstatus.dev/badge" />-```--If you want the dark version of the badge, you can use the following URL:--```html-<img src="https://YOUR-SLUG.openstatus.dev/badge?theme=dark" />-```--You can also customize the size of the badge by adding a `size` parameter:--- `sm`-- `md`-- `lg`-- `xl`---```html-<img src="https://YOUR-SLUG.openstatus.dev/badge?theme=dark&size=xl" />-```+You can create a status page with OpenStatus.dev and display the status of your synthetic checks.-## Add monitors metrics π+You can see our own status page at [https://status.openstatus.dev](https://status.openstatus.dev).-If you make your <a href="/status-page/customization/monitors">monitor public</a>, you can display the metrics on your status page.\ No newline at end of filediff --git a/apps/docs/src/content/docs/tools/status-widget.mdx b/apps/docs/src/content/docs/tools/status-widget.mdxindex c2e0cdb37..2cd5b20b4 100644--- a/apps/docs/src/content/docs/tools/status-widget.mdx+++ b/apps/docs/src/content/docs/tools/status-widget.mdx@@ -17,7 +17,7 @@ curl https://api.openstatus.dev/public/status/:slug<Aside>We have released an `@openstatus/react` npm package that allows you to easilyintegrate the pre-typed status into your React projects or use the default- widget. Read more [here](/packages/react).+ widget. Read more [here](/tools/react).</Aside>The response is a JSON object with the following structure:diff --git a/packages/emails/emails/welcome.tsx b/packages/emails/emails/welcome.tsxindex 651e6351f..739589b84 100644--- a/packages/emails/emails/welcome.tsx+++ b/packages/emails/emails/welcome.tsx@@ -21,17 +21,16 @@ const WelcomeEmail = () => {<br />Here are a few things you can do with OpenStatus:<br />- Use our{" "}- <a href="https://docs.openstatus.dev/packages/terraform">- Terraform providers+ <a href="https://docs.openstatus.dev/tools/terraform">+ Terraform provider</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>{" "}- and{" "}- <a href="https://docs.openstatus.dev/packages/react">React Widget</a>+ <a href="https://docs.openstatus.dev/tools/status-widget">API</a> and{" "}+ <a href="https://docs.openstatus.dev/tools/react/">React Widget</a><br />- Build your own status page with our{" "}- <a href="https://docs.openstatus.dev/api-reference">API</a> and host- it where you want. Here's our{" "}+ <a href="https://api.openstatus.dev/v1">API</a> and host it where you+ want. Here's our{" "}<a href="https://github.com/openstatusHQ/astro-status-page">Astro template</a>{" "}