Skip to content

Commit

Permalink
📝 docs improvments (#1126)
Browse files Browse the repository at this point in the history
* 📝 improvments

* 📝 improvments

* ci: apply automated fixes

* 📝 improvments

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
  • Loading branch information
thibaultleouay and autofix-ci[bot] authored Dec 5, 2024
1 parent fd018dc commit 50b980f
Show file tree
Hide file tree
Showing 12 changed files with 313 additions and 339 deletions.
14 changes: 7 additions & 7 deletions apps/docs/astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -57,23 +57,23 @@ export default defineConfig({
items: [
{ label: "Overview", slug: "monitoring/overview" },
{
label: "Create you first monitor",
label: "Create a synthetic check",
slug: "monitoring/create-monitor",
},
{
label: "View your monitor data",
label: "View your results data",
slug: "monitoring/monitor-data-collected",
},
{
label: "Group your monitors",
label: "Group your checks",
slug: "monitoring/group-monitor-tag",
},
{
label: "Clone a monitor",
label: "Clone a check",
slug: "monitoring/clone-monitor",
},
{
label: "Monitor Types",
label: "Check Types",
collapsed: true,
items: [
{
Expand Down Expand Up @@ -103,8 +103,8 @@ export default defineConfig({
slug: "monitoring/customization/notification",
},
{
label: "Regions",
slug: "monitoring/customization/regions",
label: "Locations",
slug: "monitoring/customization/locations",
},
{
label: "Timing",
Expand Down
6 changes: 3 additions & 3 deletions apps/docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,15 @@
"@astrojs/sitemap": "3.2.1",
"@astrojs/starlight": "0.29.2",
"@astrojs/starlight-tailwind": "2.0.3",
"@astrojs/tailwind": "5.1.2",
"@astrojs/tailwind": "5.1.3",
"astro": "4.16.14",
"sharp": "0.33.5",
"starlight-showcases": "0.2.0",
"starlight-sidebar-topics": "0.2.1",
"unplugin-icons": "0.20.1"
},
"devDependencies": {
"@iconify-json/lucide": "1.2.15",
"typescript": "5.6.3"
"@iconify-json/lucide": "1.2.17",
"typescript": "5.7.2"
}
}
Binary file added apps/docs/src/assets/monitor/create-monitor.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/monitor/overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 5 additions & 1 deletion apps/docs/src/content/config.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
import { defineCollection } from "astro:content";
import { docsSchema } from "@astrojs/starlight/schema";
// import { glob } from "astro/loaders";
import { topicSchema } from "starlight-sidebar-topics/schema";

export const collections = {
docs: defineCollection({ schema: docsSchema({ extend: topicSchema }) }),
docs: defineCollection({
// loader: glob({ pattern: "**/*.mdx", base: "./src/content/docs" }),
schema: docsSchema({ extend: topicSchema }),
}),
};
15 changes: 12 additions & 3 deletions apps/docs/src/content/docs/getting-started/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,18 @@ You can [sign up](https://www.openstatus.dev/app/login?ref=docs) for a free acco
All our code is open-source and you can host it on your own infrastructure.

<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.
It is not easy to self-host OpenStatus on your own at the moment. We will be working on community version to make it easier in the future.
</Aside>

### Lightweight Self hosted
### Commmunity version

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).
We are working on a multiple community version of OpenStatus that will be easier to self-host.

#### Vercel Edge Checker

You can use our [Vercel Edge Checker](https://github.com/openstatusHQ/vercel-edge-ping) version of OpenStatus. It is a simple version of OpenStatus that can be deployed to Vercel with one click.


<Aside>
More version will be available in the future. 🚧
</Aside>
1 change: 1 addition & 0 deletions apps/docs/src/content/docs/guides/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Introduction
description: Guides to get started with OpenStatus
sidebar:
label: Introduction
order: 1
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/src/content/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ 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.
[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, or anything that can be monitored from various locations around the world.

We also provide beautiful [status pages](/status-page/overview) to keep your users informed about the status of your services.

Expand Down
17 changes: 16 additions & 1 deletion apps/docs/src/content/docs/monitoring/create-monitor.mdx
Original file line number Diff line number Diff line change
@@ -1,13 +1,28 @@
---
title: How to create a monitor?
title: How to create a synthetic check?
description: "How to create your first monitor with OpenStatus"
---

import { Image } from 'astro:assets';
import { Aside, CardGrid, LinkCard } from '@astrojs/starlight/components';
import monitorDetail from '../../../assets/monitor/monitor-detail.png';
import createMonitor from '../../../assets/monitor/create-monitor.png';

import { ShowcaseYouTube } from 'starlight-showcases'

<Image
src={createMonitor}
alt="Charts with status code and response time"
/>

First you need to create a monitor to start monitoring your services.

## What is a monitor?

A monitor is a job that runs periodically or on-demand and checks the status of a service. A monitor will do some synthetic checks to ensure that your service is working as expected.


## Create your first monitor

Go to the **Monitors** page and click on the **Create Monitor** button.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
---
title: Regions
description: "How to change the regions for your synthetic checks in OpenStatus"
title: Locations
description: "How to change the locations for your synthetic checks in OpenStatus"
---


We have multiple locations around the world to monitor your services. You can choose from public locations or use private locations that you own and manage.

## Public Locations

For free users, OpenStatus will monitor your service from six location, one on every continent. For paid users, you can choose from multiple locations around the world to monitor your service.


To change regions for your monitors: _Select a monitor &rarr; Settings &rarr; Scheduling & Regions_.

Africa
Expand Down Expand Up @@ -58,3 +64,8 @@ South America
Oceania

- Sydney, Australia 🇦🇺 (free)


## Private Locations

You can also use private locations to monitor your services. Private locations are servers that you own and manage. If you want to use private locations, please [contact us](mailto:ping@openstatus.dev) for more information.
13 changes: 12 additions & 1 deletion apps/docs/src/content/docs/monitoring/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,16 @@
---
title: Overview
description: "How to create your first monitor with OpenStatus.dev"
description: "Learn more about synthetic monitoring and how to use it with OpenStatus"
---

import { CardGrid, LinkCard } from '@astrojs/starlight/components';
import { Image } from 'astro:assets';
import overview from '../../../assets/monitor/overview.png';

<Image
src={overview}
alt="Charts with status code and response time"
/>

With synthetic monitoring, you can simulated requests to monitor the availability and performance of
your website, API, or server from various locations around the world.
Expand All @@ -16,6 +23,10 @@ We will alert you if your website or API is down, is timing out or does not retu
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 synthetic monitoring?

Synthetic monitoring is a type of monitoring that simulates user interactions with your website or API. It is used to monitor the availability and performance of your website or API from various locations around the world to ensure that it is working as expected.

### What is a monitor?

A monitor is a job that runs periodically or on-demand and checks the status of a service. It
Expand Down
Loading

0 comments on commit 50b980f

Please sign in to comment.