Skip to content

Commit

Permalink
📝 more docs content (#1107)
Browse files Browse the repository at this point in the history
* 📝 more content

* 📝 more content

* ci: apply automated fixes

* 📝 more content

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
  • Loading branch information
thibaultleouay and autofix-ci[bot] authored Nov 22, 2024
1 parent a95f63a commit 4353c6c
Show file tree
Hide file tree
Showing 28 changed files with 288 additions and 236 deletions.
35 changes: 23 additions & 12 deletions apps/docs/astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,10 @@ export default defineConfig({
label: "Frequency",
slug: "monitoring/customization/frequency",
},
{
label: "Notifications",
slug: "monitoring/customization/notification",
},
{
label: "Regions",
slug: "monitoring/customization/regions",
Expand All @@ -107,18 +111,11 @@ export default defineConfig({
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" },
{ label: "Custom Domain", slug: "status-page/custom-domain" },
{
label: "Subscribers",
slug: "status-page/subscribers",
},

{
label: "Customization",
autogenerate: { directory: "status-page/customization" },
collapsed: true,
label: "Work with Status Page",
autogenerate: { directory: "status-page/work" },
collapsed: false,
},
{
label: "Advanced",
Expand All @@ -127,7 +124,21 @@ export default defineConfig({
},
],
},
{ label: "Incidents", autogenerate: { directory: "incident" } },
{
label: "Incidents",
items: [
{ label: "Overview", slug: "incident/overview" },
{
label: "Work with incident",
slug: "incident/work-with-incident",
},

{
label: "Incident Detail",
slug: "incident/incident-detail",
},
],
},
{
label: "Alerting",
items: [
Expand Down
12 changes: 6 additions & 6 deletions apps/docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@
},
"dependencies": {
"@astrojs/check": "0.9.4",
"@astrojs/sitemap": "^3.2.1",
"@astrojs/starlight": "0.28.6",
"@astrojs/starlight-tailwind": "^2.0.3",
"@astrojs/tailwind": "^5.1.2",
"astro": "4.16.10",
"@astrojs/sitemap": "3.2.1",
"@astrojs/starlight": "0.29.2",
"@astrojs/starlight-tailwind": "2.0.3",
"@astrojs/tailwind": "5.1.2",
"astro": "4.16.14",
"sharp": "0.33.5",
"starlight-showcases": "0.2.0",
"starlight-sidebar-topics": "0.2.0",
"starlight-sidebar-topics": "0.2.1",
"unplugin-icons": "0.20.1"
},
"devDependencies": {
Expand Down
Binary file added apps/docs/src/assets/cli/CLI.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added apps/docs/src/assets/status-page/description.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added apps/docs/src/assets/status-page/favicon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions apps/docs/src/content/docs/alerting/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ If you connect notification channels to your OpenStatus account, you can receive
alerts when your services are down. We will contact you when an incident is
created.

By default we don't send any notification. You need to connect your monitor to a notification channel to receive alerts.

<Image
src={DiscordNotification}
alt="Create your notification bot"
Expand Down
11 changes: 11 additions & 0 deletions apps/docs/src/content/docs/cli/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,17 @@
title: Getting Started
---

import { Image } from 'astro:assets';

import CLI from '../../../assets/cli/CLI.png';

<Image
src={CLI}
alt="OpenStatus CLI"
/>



You can use the OpenStatus CLI to manage and run your synthetic checks. The CLI is a powerful tool that allows you to interact with OpenStatus from your terminal.

## Installation
Expand Down
4 changes: 0 additions & 4 deletions apps/docs/src/content/docs/dummy/ping_response__v5.csv

This file was deleted.

12 changes: 7 additions & 5 deletions apps/docs/src/content/docs/getting-started/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,16 @@ You can either use the cloud version of OpenStatus or self-host it.

### Cloud version

You can (sign up)[https://www.openstatus.dev/app/login?ref=docs] for a free account and start monitoring your services in seconds.
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
### Self 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.
</Aside>
</Aside>

### Lightweight Self hosted

If you want to self-host OpenStatus, you can use our lightweight version of OpenStatus called [Vercel Edge Checker](https://github.com/openstatusHQ/vercel-edge-ping).
20 changes: 20 additions & 0 deletions apps/docs/src/content/docs/incident/incident-detail.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: Incident Detail
order: 2
---

import { Image } from 'astro:assets';
import IncidentDetail from '../../../assets/incident/incident-detail.png';
import { Aside } from '@astrojs/starlight/components';


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.


<Image
src={IncidentDetail}
alt="Incident page"
/>

<Aside>There might be a delay between the incident creation and the screenshot capture. Your endpoint could have already recovered.</Aside>
33 changes: 1 addition & 32 deletions apps/docs/src/content/docs/incident/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,42 +1,11 @@
---
title: Overview
description: "How incident are created, how to acknowledge, and resolve them🔥"
description: "How incident are created, how to acknowledge, and resolve them"
---
import { Aside } from '@astrojs/starlight/components';
import { Image } from 'astro:assets';
import IncidentDetail from '../../../assets/incident/incident-detail.png';


When we detect a problem with your service, we create an incident.
## What is an incident 🧑‍🏫

We automatically create an incident when we detect a problem with your service.
When a monitor fails in more than 50% of the locations, we create an incident.
We do that in order to avoid false positives.

## How to acknowledge an incident

Go to the incident page and click on the acknowledge button.

## How to resolve an incident

Go to the incident page and click on the resolve button.

## Auto resolve an incident

We automatically resolve an incident when the monitor is passing in more than
50% 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.


<Image
src={IncidentDetail}
alt="Incident page"
/>

<Aside>There might be a delay between the incident creation and the screenshot capture. Your endpoint could have already recovered.</Aside>
24 changes: 24 additions & 0 deletions apps/docs/src/content/docs/incident/work-with-incident.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: Work with Incidents
---

An incident can have the following states:

- **On Going**: The incident is still active.
- **Acknowledged**: The incident has been acknowledged.
- **Resolved**: The incident has been resolved.

## How to acknowledge an incident

Go to the incident page and click on the acknowledge button.

## How to resolve an incident

Go to the incident page and click on the resolve button.

## Auto resolve an incident

We automatically resolve an incident when the monitor is passing in more than
50% of the locations.


Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Notification
---

By default your monitor won't send any notification on failure. You can enable notifications for your monitor by connecting it to a notification channel.
2 changes: 1 addition & 1 deletion apps/docs/src/content/docs/status-page/advanced/badge.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Status Page Badge
title: Badge
---

You can embed the status page badge on your website or GitHub README to show the
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,6 @@ import { Aside } from '@astrojs/starlight/components';

<Aside>This is a paid feature only</Aside>

To connect a custom domain to your status page: _Select a status page &rarr; Domain &rarr;_.
To connect a custom domain to your status page: _Select a status page &rarr; Domain &rarr;_.

You will be asked to enter your custom domain. And we will provide you with a DNS record to add to your domain provider.
21 changes: 21 additions & 0 deletions apps/docs/src/content/docs/status-page/advanced/description.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: Description
---

import { Image } from 'astro:assets';

import StatusPage from '../../../../assets/status-page/description.png';


You can set a custom description for your status page. The description will be displayed on the status page.

To add a custom description for your status page: _Select a status page &rarr; Settings &rarr; Advanced_.




<Image
src={StatusPage}
alt="OpenStatus status page"
/>

19 changes: 19 additions & 0 deletions apps/docs/src/content/docs/status-page/advanced/icon.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: Icon
---

import { Image } from 'astro:assets';

import StatusPage from '../../../../assets/status-page/favicon.png';



You can set a custom icon for your status page. The icon will be displayed in the browser tab and on the status page.

To add a custom favicon for your status page: _Select a status page &rarr; Settings &rarr; Advanced_.


<Image
src={StatusPage}
alt="OpenStatus status page"
/>
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,6 @@ To change the visibility of the values: _Select a status page &rarr; Settings &r

If you want to share all your monitor metrics with your users, you can make your monitor public. This will allow you to display the metrics on your status page.

To make a monitor public: _Select a monitor &rarr; Settings &rarr; Danger &rarr; Toggle Public monitor.
To make a monitor public: _Select a monitor &rarr; Settings &rarr; Danger &rarr; Toggle Public monitor.

You can see an example of a public monitor at [https://status.openstatus.dev/monitors/1](https://status.openstatus.dev/monitors/1).
11 changes: 9 additions & 2 deletions apps/docs/src/content/docs/status-page/create-status-page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,14 @@ 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
<Image
src={StatusPageEmpty}
alt="Create your status page"
/>
/>


Then you need to give your status page a name and choose a slug.

Your status page will be available at `https://<slug>.openstatus.dev/`.

You can also set a [custom domain](/status-page/advanced/custom-domain) for your status page.

This file was deleted.

18 changes: 0 additions & 18 deletions apps/docs/src/content/docs/status-page/reports.mdx

This file was deleted.

34 changes: 34 additions & 0 deletions apps/docs/src/content/docs/status-page/work/reports.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
title: Status Page Report
description: "What is a Status Page Report 🔥"
---
## What is a Status Page Report?

A status page report is a timeline of status updates that can be shared with your users. It is a great way to keep your users informed about the status of your application, website or service.

Only the update that happened during the last 7 days will be displayed on the main page of your status page.
Otherwise they will be displayed on your status page and under the **Event** tab.

## How to create a Status Page Report?

Go to your **status page** tab, select your status page click on the **Status report**.

When creating a status report, you can map it to a **monitor** or not. This will allow you access the latest reports on your status
page.

If you don't select a monitor, this is useful if you want to inform your users about an incident, a maintenance of a third party provider.

Update your report over time and keep your users informed. Add a new **status**,
**date** and **message** to your report. They will be displayed on a timeline.


### Status update

The status update can be one of the following:

- **Investigating**: You are investigating an issue
- **Identified**: You have identified the issue
- **Monitoring**: You are monitoring the issue
- **Resolved**: The issue has been resolved


Loading

0 comments on commit 4353c6c

Please sign in to comment.