📝 typo docs (#1118)

openstatusHQ · Nov 27, 2024 · 1b8fc26 · 1b8fc26
1 parent 341a75a
commit 1b8fc26
Show file tree

Hide file tree

Showing 41 changed files with 64 additions and 37 deletions.
diff --git a/README.md b/README.md
@@ -75,8 +75,8 @@ Made with [Contrib.rocks](https://contrib.rocks)
 - [Next.js](https://nextjs.org/)
 - [Tailwind CSS](https://tailwindcss.com/)
 - [shadcn/ui](https://ui.shadcn.com/)
-- [tinybird](http://tinybird.co/?ref=openstatus.dev)
-- [turso](http://turso.tech/)
+- [tinybird](https://tinybird.co/?ref=openstatus.dev)
+- [turso](https://turso.tech/)
 - [drizzle](https://orm.drizzle.team/)
 - [Resend](https://resend.com/)
 

diff --git a/apps/docs/src/content/docs/alerting/overview.mdx b/apps/docs/src/content/docs/alerting/overview.mdx
@@ -1,5 +1,6 @@
 ---
 title: Overview
+description: "Discover the different notification channels available in OpenStatus"
 ---
 import { Card } from '@astrojs/starlight/components';
 import { CardGrid } from '@astrojs/starlight/components';
@@ -28,4 +29,4 @@ By default we don't send any notification. You need to connect your monitor to a
   <LinkCard title="Pagerduty 📟" href="/alerting/providers/pagerduty" description="Receive a pagerduty notification"/ >
   <LinkCard title="Phone 📞" href="/alerting/providers/phone-call" description="Get called on your phone" />
   <LinkCard title="Telegram 📡" href="/alerting/providers/telegram" description="Get notified on Telegram" />
-</CardGrid>
+</CardGrid>
diff --git a/apps/docs/src/content/docs/alerting/providers/discord.mdx b/apps/docs/src/content/docs/alerting/providers/discord.mdx
@@ -1,5 +1,6 @@
 ---
 title: Discord
+description: "How to set up Discord notifications in OpenStatus to get alerts when your synthetic check fail"
 ---
 
 When a monitor is down you can set up a webhook to send a message to a Discord

diff --git a/apps/docs/src/content/docs/alerting/providers/email.mdx b/apps/docs/src/content/docs/alerting/providers/email.mdx
@@ -1,5 +1,7 @@
 ---
 title: Email
+description: "How to set up Email notifications in OpenStatus to get alerts when your synthetic check fail"
+
 ---
 
 When we create an incident we send an email to the email provided.
diff --git a/apps/docs/src/content/docs/alerting/providers/pagerduty.mdx b/apps/docs/src/content/docs/alerting/providers/pagerduty.mdx
@@ -1,5 +1,7 @@
 ---
 title: PagerDuty
+description: "How to set up PagerDuty notifications in OpenStatus to get alerts when your synthetic check fail"
+
 ---
 import { Image} from 'astro:assets';
 import PagerDuty1 from '../../../../assets/notification/pagerduty/pagerduty-1.png';
@@ -36,4 +38,4 @@ Select the service you want to use to send notifications. You can create a new s
 
 You are now connected to PagerDuty.  Give your integration a name and save it.
 
-You will receive some notifications if we detect an incident
+You will receive some notifications if we detect an incident
diff --git a/apps/docs/src/content/docs/alerting/providers/phone-call.mdx b/apps/docs/src/content/docs/alerting/providers/phone-call.mdx
@@ -1,5 +1,7 @@
 ---
 title: Phone call
+description: "How to set up phone call notifications in OpenStatus to get alerts when your synthetic check fail"
+
 ---
 
 Receive a phone call when your monitor is down.

diff --git a/apps/docs/src/content/docs/alerting/providers/slack.mdx b/apps/docs/src/content/docs/alerting/providers/slack.mdx
@@ -1,5 +1,7 @@
 ---
 title: Slack
+description: "How to set up Slack notifications in OpenStatus to get alerts when your synthetic check fail"
+
 ---
 
 When a monitor is down, a message can be sent to a Slack channel. To enable this

diff --git a/apps/docs/src/content/docs/alerting/providers/sms.mdx b/apps/docs/src/content/docs/alerting/providers/sms.mdx
@@ -1,5 +1,7 @@
 ---
 title: SMS
+description: "How to set up SMS notifications in OpenStatus to get alerts when your synthetic check fail"
+
 ---
 
 When you subscribe to a paid plan you can receive SMS notifications when your

diff --git a/apps/docs/src/content/docs/alerting/providers/telegram.mdx b/apps/docs/src/content/docs/alerting/providers/telegram.mdx
@@ -1,5 +1,7 @@
 ---
 title: Telegram
+description: "How to set up Telegram notifications in OpenStatus to get alerts when your synthetic check fail"
+
 ---
 
 🚧 Coming soon 🚧
diff --git a/apps/docs/src/content/docs/cli/commands/monitors.mdx b/apps/docs/src/content/docs/cli/commands/monitors.mdx
@@ -1,5 +1,6 @@
 ---
 title: Monitors
+description: "Manage your monitors in OpenStatus from the command line"
 ---
 
 The monitors command is used to manage your monitors. You trigger, view and list your monitors using this command.
@@ -32,4 +33,3 @@ You can trigger a monitor using the following command.
 ```bash
 openstatus monitors trigger <monitor-id>
 ```
-
diff --git a/apps/docs/src/content/docs/cli/commands/run.mdx b/apps/docs/src/content/docs/cli/commands/run.mdx
@@ -1,5 +1,6 @@
 ---
 title: Run
+description: "How to run a list of synthetic checks in OpenStatus from the command line"
 ---
 
 This command is used to run a list of synthetic check.
@@ -21,4 +22,4 @@ openstatus run
 
 ### Options
 
-- `--config` - Path to the config file. Default is `config.openstatus.yaml`.
+- `--config` - Path to the config file. Default is `config.openstatus.yaml`.
diff --git a/apps/docs/src/content/docs/cli/commands/whoami.mdx b/apps/docs/src/content/docs/cli/commands/whoami.mdx
@@ -1,5 +1,6 @@
 ---
 title: Whoami
+description: "How to check the currently authenticated user in OpenStatus with the whoami command"
 ---
 
-The `whoami` command is used to display the currently authenticated user. This command is useful to check if you are logged in and to see the workspace details.
+The `whoami` command is used to display the currently authenticated user. This command is useful to check if you are logged in and to see the workspace details.
diff --git a/apps/docs/src/content/docs/cli/getting-started.mdx b/apps/docs/src/content/docs/cli/getting-started.mdx
@@ -1,5 +1,6 @@
 ---
 title: Getting Started
+description: "Get started with OpenStatus CLI and start triggering your synthetic checks from your terminal"
 ---
 
 import { Image } from 'astro:assets';
@@ -49,4 +50,4 @@ or you can set the `--access-token` option in the CLI command.
 
 ```bash
 openstatus [COMMAND] --access-token your-api-token
-```
+```
diff --git a/apps/docs/src/content/docs/incident/incident-detail.mdx b/apps/docs/src/content/docs/incident/incident-detail.mdx
@@ -1,5 +1,6 @@
 ---
 title: Incident Detail
+description: "Discover the incident details in OpenStatus"
 order: 2
 ---
 

diff --git a/apps/docs/src/content/docs/incident/overview.mdx b/apps/docs/src/content/docs/incident/overview.mdx
@@ -1,6 +1,6 @@
 ---
 title: Overview
-description: "How incident are created, how to acknowledge, and resolve them"
+description: "Discover what is an incident in OpenStatus"
 ---
 
 

diff --git a/apps/docs/src/content/docs/incident/work-with-incident.mdx b/apps/docs/src/content/docs/incident/work-with-incident.mdx
@@ -1,5 +1,6 @@
 ---
 title: Work with Incidents
+description: "How to acknowledge and resolve incidents in OpenStatus"
 ---
 
 An incident can have the following states:

diff --git a/apps/docs/src/content/docs/monitoring/clone-monitor.mdx b/apps/docs/src/content/docs/monitoring/clone-monitor.mdx
@@ -1,6 +1,6 @@
 ---
 title: How to clone a monitor?
-description: "How to clone your first monitor with OpenStatus.dev"
+description: "How to clone a monitor with OpenStatus"
 ---
 
 import { Image } from 'astro:assets';
@@ -15,4 +15,3 @@ By default, the cloned monitor will be in the **inactive** state to allow you to
     src={monitorDetail}
     alt="Charts with status code and response time"
   />
-
diff --git a/apps/docs/src/content/docs/monitoring/create-monitor.mdx b/apps/docs/src/content/docs/monitoring/create-monitor.mdx
@@ -1,6 +1,6 @@
 ---
 title: How to create a monitor?
-description: "How to create your first monitor with OpenStatus.dev"
+description: "How to create your first monitor with OpenStatus"
 ---
 
 import { Image } from 'astro:assets';

diff --git a/apps/docs/src/content/docs/monitoring/customization/assertions.mdx b/apps/docs/src/content/docs/monitoring/customization/assertions.mdx
@@ -1,6 +1,6 @@
 ---
 title: Assertions
-description: "How to monitor your HTTP services with OpenStatus.dev"
+description: "How to set up assertions for your synthetic checks in OpenStatus"
 ---
 
 
@@ -38,4 +38,3 @@ Supports `Equal`, `Not equal`, `Contains`, `Does not Contain`, `Empty`, `Not emp
 Define the **body string** you want to check for.
 
 Supports `Equal`, `Not equal`, `Contains`, `Does not Contain`, `Empty`, `Not empty`, `Greater than`, `Less than`, `Greater than or equal`, `Less than or equal` assertions.
-
diff --git a/apps/docs/src/content/docs/monitoring/customization/frequency.mdx b/apps/docs/src/content/docs/monitoring/customization/frequency.mdx
@@ -1,6 +1,6 @@
 ---
 title: Frequency
-description: "How to monitor your HTTP services with OpenStatus.dev"
+description: "How to change the frequency of your synthetic checks in OpenStatus"
 ---
 
 By default, OpenStatus.dev will check your service every 30 minutes.
@@ -16,4 +16,4 @@ We support the following frequencies:
 - Every 5 minutes
 - Every 10 minutes
 - Every 30 minutes
-- Every 1 hour
+- Every 1 hour
diff --git a/apps/docs/src/content/docs/monitoring/customization/notification.mdx b/apps/docs/src/content/docs/monitoring/customization/notification.mdx
@@ -1,5 +1,6 @@
 ---
 title: Notifications
+description: "How to set up notifications for your synthetic checks in OpenStatus"
 ---
 import { Image } from 'astro:assets';
 import { Aside} from '@astrojs/starlight/components';
@@ -22,4 +23,4 @@ You need to create a notification channel before connecting your monitor to it.
 
 <Aside>
 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.
-</Aside>
+</Aside>
diff --git a/apps/docs/src/content/docs/monitoring/customization/regions.mdx b/apps/docs/src/content/docs/monitoring/customization/regions.mdx
@@ -1,6 +1,6 @@
 ---
 title: Regions
-description: "How to monitor your HTTP services with OpenStatus.dev"
+description: "How to change the regions for your synthetic checks in OpenStatus"
 ---
 
 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.
@@ -57,4 +57,4 @@ South America
 
 Oceania
 
-- Sydney, Australia 🇦🇺 (free)
+- Sydney, Australia 🇦🇺 (free)
diff --git a/apps/docs/src/content/docs/monitoring/customization/timing.mdx b/apps/docs/src/content/docs/monitoring/customization/timing.mdx
@@ -1,10 +1,10 @@
 ---
 title: Timing
-description: "How to monitor your HTTP services with OpenStatus.dev"
+description: "How to set up timing threshold for your synthetic checks in OpenStatus"
 ---
 
 By default, OpenStatus will timeout after `45s` but you can set a custom timeout (max. `45s`).
 
 You can also set a custom degraded threshold. If the response time is higher than the degraded threshold, the status will be set to `Degraded` and we will send a notification.
 
-To change assertions for your monitors: _Select a monitor &rarr; Settings &rarr; Timing & Assertions_.
+To change assertions for your monitors: _Select a monitor &rarr; Settings &rarr; Timing & Assertions_.
diff --git a/apps/docs/src/content/docs/monitoring/group-monitor-tag.mdx b/apps/docs/src/content/docs/monitoring/group-monitor-tag.mdx
@@ -1,5 +1,6 @@
 ---
 title: How to group your monitors
+description: "How to group your monitors in OpenStatus to manage them more efficiently"
 ---
 
 import { Image } from 'astro:assets';

diff --git a/apps/docs/src/content/docs/monitoring/monitor-data-collected.mdx b/apps/docs/src/content/docs/monitoring/monitor-data-collected.mdx
@@ -1,6 +1,6 @@
 ---
 title: Monitor Data Points
-description: "Monitor metrics are the data points that are collected by the monitor during the check."
+description: "Monitor metrics are the data points that are collected by the monitor during the check in OpenStatus."
 ---
 
 import { Image } from 'astro:assets';

diff --git a/apps/docs/src/content/docs/monitoring/overview.mdx b/apps/docs/src/content/docs/monitoring/overview.mdx
@@ -28,11 +28,10 @@ We will make a request to your endpoint and record the results.
 <CardGrid>
     <LinkCard
         title="HTTP Monitor"
-        href="/type/http"
+        href="/monitoring/type/http"
     />
     <LinkCard
         title="TCP Monitor"
-        href="/type/tcp"
+        href="/monitoring/type/tcp"
     />
 </CardGrid>
-
diff --git a/apps/docs/src/content/docs/monitoring/type/http.mdx b/apps/docs/src/content/docs/monitoring/type/http.mdx
@@ -1,6 +1,6 @@
 ---
 title: HTTP
-description: "How to monitor your HTTP services with OpenStatus.dev"
+description: "How to monitor your HTTP services with OpenStatus"
 ---
 import { Image } from 'astro:assets';
 

diff --git a/apps/docs/src/content/docs/monitoring/type/tcp.mdx b/apps/docs/src/content/docs/monitoring/type/tcp.mdx
@@ -1,6 +1,6 @@
 ---
 title: TCP
-description: "How to monitor your TCP services with OpenStatus.dev"
+description: "How to monitor your TCP services with OpenStatus"
 ---
 
 import { Image } from 'astro:assets';

diff --git a/apps/docs/src/content/docs/status-page/advanced/badge.mdx b/apps/docs/src/content/docs/status-page/advanced/badge.mdx
@@ -1,5 +1,6 @@
 ---
 title: Badge
+description: "How to embed the status page badge on your website or GitHub README"
 ---
 
 You can embed the status page badge on your website or GitHub README to show the

diff --git a/apps/docs/src/content/docs/status-page/advanced/custom-domain.mdx b/apps/docs/src/content/docs/status-page/advanced/custom-domain.mdx
@@ -1,5 +1,6 @@
 ---
 title: Custom Domain
+description: "How to connect a custom domain to your status page in OpenStatus"
 ---
 
 import { Aside } from '@astrojs/starlight/components';

diff --git a/apps/docs/src/content/docs/status-page/advanced/description.mdx b/apps/docs/src/content/docs/status-page/advanced/description.mdx
@@ -1,5 +1,6 @@
 ---
 title: Description
+description: "How to set a custom description for your status page in OpenStatus"
 ---
 
 import { Image } from 'astro:assets';

diff --git a/apps/docs/src/content/docs/status-page/advanced/icon.mdx b/apps/docs/src/content/docs/status-page/advanced/icon.mdx
@@ -1,5 +1,6 @@
 ---
 title: Icon
+description: "How to set a custom icon for your status page in OpenStatus"
 ---
 
 import { Image } from 'astro:assets';

diff --git a/apps/docs/src/content/docs/status-page/advanced/monitors.mdx b/apps/docs/src/content/docs/status-page/advanced/monitors.mdx
@@ -1,5 +1,6 @@
 ---
 title: Monitors
+description: "How to connect your monitors for your status page in OpenStatus"
 ---
 
 Connect your created monitors to your status page to display the current status of your services.

diff --git a/apps/docs/src/content/docs/status-page/advanced/password.mdx b/apps/docs/src/content/docs/status-page/advanced/password.mdx
@@ -1,5 +1,6 @@
 ---
 title: Password protection
+description: "How to password protect your status page in OpenStatus"
 ---
 
 import { Aside } from '@astrojs/starlight/components';

diff --git a/apps/docs/src/content/docs/status-page/advanced/widget.mdx b/apps/docs/src/content/docs/status-page/advanced/widget.mdx
@@ -1,5 +1,6 @@
 ---
 title: Public Status Widget
+description: "How to embed the public status widget in your React application"
 ---
 import { Aside } from '@astrojs/starlight/components';
 
@@ -14,7 +15,7 @@ curl https://api.openstatus.dev/public/status/:slug
 <Aside>
   We have released an `@openstatus/react` npm package that allows you to easily
   integrate 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/apps/docs/src/content/docs/status-page/create-status-page.mdx b/apps/docs/src/content/docs/status-page/create-status-page.mdx
@@ -1,5 +1,6 @@
 ---
 title: How to create a status page?
+description: "How to create a status page in OpenStatus"
 ---
 
 import { Image } from 'astro:assets';

diff --git a/apps/docs/src/content/docs/status-page/overview.mdx b/apps/docs/src/content/docs/status-page/overview.mdx
@@ -1,5 +1,6 @@
 ---
 title: Status page
+description: "Discover what is a status page in OpenStatus"
 ---
 import { Image } from 'astro:assets';
 
@@ -18,7 +19,7 @@ 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.
 
-You can create a status page with OpenStatus.dev and display the status of your synthetic checks.
+You can create a status page with OpenStatus and display the status of your synthetic checks.
 
 You can see our own status page at [https://status.openstatus.dev](https://status.openstatus.dev).
 
diff --git a/apps/docs/src/content/docs/tools/terraform.mdx b/apps/docs/src/content/docs/tools/terraform.mdx
@@ -1,7 +1,7 @@
 ---
 title: Terraform Provider
 description:
-  "Use OpenStatus Terraform provider to manage your monitors and  status page."
+  "Use OpenStatus Terraform provider to manage your monitors and status page."
 ---
 
 Here you can find the official OpenStatus Terraform provider. This provider