Open-source status page, incident response and uptime monitoring
TypeScript alertingincident-managementmcpmcp-servermonitoringmonitoring-as-codeobservabilityon-callopen-sourcesrestatus-pagestatuspagesynthetic-monitoringterraformtinybirdtursouptimeuptime-checkeruptime-monitor
fix: mdx content heading hierarchy (#2431)
Maximilian Kaske8d798fa6bb97
diff --git a/apps/web/src/content/pages/docs/concept/getting-started.mdx b/apps/web/src/content/pages/docs/concept/getting-started.mdxindex fcf55c73d..393251216 100644--- a/apps/web/src/content/pages/docs/concept/getting-started.mdx+++ b/apps/web/src/content/pages/docs/concept/getting-started.mdx@@ -8,7 +8,7 @@ This section is dedicated to explanation. It's not about quick fixes or step-by-A solid mental model lets you use the tools more effectively, make better decisions for your own systems, and communicate with your team and stakeholders with clarity. We'll explore the "why" behind the "what" — core concepts, best practices, and the design philosophy that guides the product.-### Core concepts+## Core concepts- **[Uptime monitoring](/docs/concept/uptime-monitoring)** — what is it, why does it matter, and how does it work?- **[Uptime calculation and values](/docs/concept/uptime-calculation-and-values)** — a look under the hood at how uptime percentages are calculated and what they truly represent.@@ -17,7 +17,7 @@ A solid mental model lets you use the tools more effectively, make better decisi- **[Understanding private locations](/docs/concept/private-locations)** — when to run your own probe and the trade-offs.- **[Status reports and incidents](/docs/concept/status-reports-and-incidents)** — detection vs communication: incidents, report updates, and maintenance windows.-### Best practices and philosophy+## Best practices and philosophy- **[Building trust with status pages](/docs/concept/best-practices-status-page)** — how to communicate effectively during incidents and maintain user trust.- **[Uptime monitoring as code](/docs/concept/uptime-monitoring-as-code)** — the why and how of managing your monitoring configuration in a GitOps workflow.diff --git a/apps/web/src/content/pages/docs/guides/getting-started.mdx b/apps/web/src/content/pages/docs/guides/getting-started.mdxindex 27510095b..726ec3b33 100644--- a/apps/web/src/content/pages/docs/guides/getting-started.mdx+++ b/apps/web/src/content/pages/docs/guides/getting-started.mdx@@ -9,27 +9,27 @@ sidebar:Our how-to guides solve specific problems with step-by-step instructions, walk you through advanced features and integrations, and show you how to customise and extend your openstatus setup.-### Monitoring and integration+## Monitoring and integration- **[Monitor your MCP server](/docs/guides/how-to-monitor-mcp-server)** — set up monitoring for Model Context Protocol servers.- **[Export metrics to an OTLP endpoint](/docs/guides/how-to-export-metrics-to-otlp-endpoint)** — send monitoring data to your observability platform.- **[Run synthetic tests in GitHub Actions](/docs/guides/how-to-run-synthetic-test-github-action)** — automate testing in your CI/CD pipeline.-### Status pages and widgets+## Status pages and widgets- **[Add an SVG status badge to a GitHub README](/docs/guides/how-to-add-svg-status-badge)** — display real-time status in your repository.- **[Use the React status widget](/docs/guides/how-to-use-react-widget)** — embed live status updates in your React application.- **[Embed a status page in an iframe](/docs/guides/how-to-embed-status-page-iframe)** — drop a chromeless status page into any site.- **[Deploy a status page on Cloudflare Pages](/docs/guides/how-deploy-status-page-cf-pages)** — host your status page on Cloudflare's edge network.-### Infrastructure and deployment+## Infrastructure and deployment- **[Create a private location](/docs/guides/how-to-create-private-location)** — run a monitoring probe on your own infrastructure.- **[Deploy a private probe on Cloudflare Containers](/docs/guides/how-to-deploy-probes-cloudflare-containers)** — serverless deployment for private probes.- **[Self-host openstatus](/docs/guides/self-hosting-openstatus)** — deploy openstatus on your own servers.- **[Self-host the status page only](/docs/guides/self-host-status-page-only)** — deploy just the status page without monitoring.-### Related sections+## Related sections- **[Tutorials](/docs/tutorial/getting-started)** — for step-by-step learning instead.- **[Explanations](/docs/concept/getting-started)** — to understand the concepts behind these guides.diff --git a/apps/web/src/content/pages/docs/reference/cli-reference.mdx b/apps/web/src/content/pages/docs/reference/cli-reference.mdxindex b70ff6ccd..c01f81d7e 100644--- a/apps/web/src/content/pages/docs/reference/cli-reference.mdx+++ b/apps/web/src/content/pages/docs/reference/cli-reference.mdx@@ -21,7 +21,7 @@ Global flags:| `--quiet` (`-q`) | Suppress non-error output | bool | `false` | *none* || `--debug` | Enable debug output | bool | `false` | *none* |-### `check` command (aliases: `c`)+## `check` command (aliases: `c`)Run an HTTP check against a URL from 28 global regions.@@ -49,7 +49,7 @@ The following flags are supported:| `--body="…"` (`-d`) | Request body. Use @filename to read a file, @- for stdin | string | | *none* || `--timing` | Show DNS/Connection/TLS/TTFB/Transfer phases | bool | `false` | *none* |-### `monitors` command (aliases: `m`)+## `monitors` command (aliases: `m`)Manage your monitors.@@ -264,7 +264,7 @@ The following flags are supported:|-----------------------------|-----------------------------|--------|:-------------:|:----------------------:|| `--access-token="…"` (`-t`) | openstatus API Access Token | string | | `OPENSTATUS_API_TOKEN` |-### `status-report` command (aliases: `sr`)+## `status-report` command (aliases: `sr`)Manage status reports.@@ -401,7 +401,7 @@ The following flags are supported:| `--date="…"` | Date for the update (RFC 3339 format, defaults to now) | string | | *none* || `--notify` | Notify subscribers about this update | bool | `false` | *none* |-### `maintenance` command (aliases: `mt`)+## `maintenance` command (aliases: `mt`)Manage maintenance windows.@@ -519,7 +519,7 @@ The following flags are supported:| `--access-token="…"` (`-t`) | openstatus API Access Token | string | | `OPENSTATUS_API_TOKEN` || `--auto-accept` (`-y`) | Automatically accept the prompt | bool | `false` | *none* |-### `status-page` command (aliases: `sp`)+## `status-page` command (aliases: `sp`)Manage status pages.@@ -568,7 +568,7 @@ The following flags are supported:|-----------------------------|-----------------------------|--------|:-------------:|:----------------------:|| `--access-token="…"` (`-t`) | openstatus API Access Token | string | | `OPENSTATUS_API_TOKEN` |-### `notification` command (aliases: `n`)+## `notification` command (aliases: `n`)Manage notifications.@@ -617,7 +617,7 @@ The following flags are supported:|-----------------------------|-----------------------------|--------|:-------------:|:----------------------:|| `--access-token="…"` (`-t`) | openstatus API Access Token | string | | `OPENSTATUS_API_TOKEN` |-### `run` command (aliases: `r`)+## `run` command (aliases: `r`)Run your uptime tests.@@ -639,7 +639,7 @@ The following flags are supported:| `--config="…"` | The configuration file | string | `"config.openstatus.yaml"` | *none* || `--access-token="…"` (`-t`) | openstatus API Access Token | string | | `OPENSTATUS_API_TOKEN` |-### `whoami` command (aliases: `w`)+## `whoami` command (aliases: `w`)Get your workspace information.@@ -659,7 +659,7 @@ The following flags are supported:|-----------------------------|-----------------------------|--------|:-------------:|:----------------------:|| `--access-token="…"` (`-t`) | openstatus API Access Token | string | | `OPENSTATUS_API_TOKEN` |-### `login` command+## `login` commandSave your API token.@@ -673,7 +673,7 @@ Usage:$ openstatus [GLOBAL FLAGS] login [ARGUMENTS...]```-### `logout` command+## `logout` commandRemove saved API token.@@ -685,7 +685,7 @@ Usage:$ openstatus [GLOBAL FLAGS] logout [ARGUMENTS...]```-### `terraform` command (aliases: `tf`)+## `terraform` command (aliases: `tf`)Generate Terraform configuration.diff --git a/apps/web/src/content/pages/docs/tutorial/getting-started.mdx b/apps/web/src/content/pages/docs/tutorial/getting-started.mdxindex 17e49ef25..e39a2dc2d 100644--- a/apps/web/src/content/pages/docs/tutorial/getting-started.mdx+++ b/apps/web/src/content/pages/docs/tutorial/getting-started.mdx@@ -11,21 +11,21 @@ Our tutorials walk you end-to-end through the openstatus workflow: monitor an enIf you're new, follow the tutorials below in order. Each one builds on the previous and takes 5–10 minutes.-### Get started+## Get started1. **[Create an uptime monitor](/docs/tutorial/create-your-first-monitor)** (~5 min) — set up uptime monitoring for your first endpoint.2. **[Wire up your first notification](/docs/tutorial/your-first-notification)** (~5 min) — create a notification channel, attach it to your monitor, and confirm an alert lands.3. **[Create a status page](/docs/tutorial/create-your-first-status-page)** (~5 min) — build a public status page to communicate service health to your users.4. **[Publish your first status report](/docs/tutorial/your-first-status-report)** (~10 min) — walk the four-state incident workflow (investigating → identified → monitoring → resolved) from the dashboard.-### Automate with the CLI+## Automate with the CLIOnce you're comfortable with the dashboard, manage your stack as code:- **[Get started with the openstatus CLI](/docs/tutorial/get-started-with-openstatus-cli)** (~10 min) — install the CLI, authenticate, and import your monitors to a YAML file you can version-control.- **[Manage status reports from the CLI](/docs/tutorial/manage-status-reports-cli)** (~10 min) — open, update, and resolve a status report from the terminal during an incident.-### What's next+## What's next- Explore the [how-to guides](/docs/guides/getting-started) for specific tasks and advanced scenarios.- Dive into the [explanations](/docs/concept/getting-started) to understand the concepts behind the features.