-
-
Notifications
You must be signed in to change notification settings - Fork 443
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
8401340
commit 497b2a7
Showing
5 changed files
with
63 additions
and
43 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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" /> | ||
``` |
16 changes: 16 additions & 0 deletions
16
apps/docs/src/content/docs/status-page/create-status-page.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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" | ||
/> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 your | ||
services. It shows the current status of your services and the history of | ||
incidents. | ||
|
||
## 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. |