Openstatus www.openstatus.dev

๐Ÿ“ typo docs (#1118)

authored by

Thibault Le Ouay and committed by
GitHub
1b8fc267 341a75a8

+64 -37
+2 -2
README.md
··· 75 75 - [Next.js](https://nextjs.org/) 76 76 - [Tailwind CSS](https://tailwindcss.com/) 77 77 - [shadcn/ui](https://ui.shadcn.com/) 78 - - [tinybird](http://tinybird.co/?ref=openstatus.dev) 79 - - [turso](http://turso.tech/) 78 + - [tinybird](https://tinybird.co/?ref=openstatus.dev) 79 + - [turso](https://turso.tech/) 80 80 - [drizzle](https://orm.drizzle.team/) 81 81 - [Resend](https://resend.com/) 82 82
+2 -1
apps/docs/src/content/docs/alerting/overview.mdx
··· 1 1 --- 2 2 title: Overview 3 + description: "Discover the different notification channels available in OpenStatus" 3 4 --- 4 5 import { Card } from '@astrojs/starlight/components'; 5 6 import { CardGrid } from '@astrojs/starlight/components'; ··· 28 29 <LinkCard title="Pagerduty ๐Ÿ“Ÿ" href="/alerting/providers/pagerduty" description="Receive a pagerduty notification"/ > 29 30 <LinkCard title="Phone ๐Ÿ“ž" href="/alerting/providers/phone-call" description="Get called on your phone" /> 30 31 <LinkCard title="Telegram ๐Ÿ“ก" href="/alerting/providers/telegram" description="Get notified on Telegram" /> 31 - </CardGrid> 32 + </CardGrid>
+1
apps/docs/src/content/docs/alerting/providers/discord.mdx
··· 1 1 --- 2 2 title: Discord 3 + description: "How to set up Discord notifications in OpenStatus to get alerts when your synthetic check fail" 3 4 --- 4 5 5 6 When a monitor is down you can set up a webhook to send a message to a Discord
+2
apps/docs/src/content/docs/alerting/providers/email.mdx
··· 1 1 --- 2 2 title: Email 3 + description: "How to set up Email notifications in OpenStatus to get alerts when your synthetic check fail" 4 + 3 5 --- 4 6 5 7 When we create an incident we send an email to the email provided.
+3 -1
apps/docs/src/content/docs/alerting/providers/pagerduty.mdx
··· 1 1 --- 2 2 title: PagerDuty 3 + description: "How to set up PagerDuty notifications in OpenStatus to get alerts when your synthetic check fail" 4 + 3 5 --- 4 6 import { Image} from 'astro:assets'; 5 7 import PagerDuty1 from '../../../../assets/notification/pagerduty/pagerduty-1.png'; ··· 36 38 37 39 You are now connected to PagerDuty. Give your integration a name and save it. 38 40 39 - You will receive some notifications if we detect an incident 41 + You will receive some notifications if we detect an incident
+2
apps/docs/src/content/docs/alerting/providers/phone-call.mdx
··· 1 1 --- 2 2 title: Phone call 3 + description: "How to set up phone call notifications in OpenStatus to get alerts when your synthetic check fail" 4 + 3 5 --- 4 6 5 7 Receive a phone call when your monitor is down.
+2
apps/docs/src/content/docs/alerting/providers/slack.mdx
··· 1 1 --- 2 2 title: Slack 3 + description: "How to set up Slack notifications in OpenStatus to get alerts when your synthetic check fail" 4 + 3 5 --- 4 6 5 7 When a monitor is down, a message can be sent to a Slack channel. To enable this
+2
apps/docs/src/content/docs/alerting/providers/sms.mdx
··· 1 1 --- 2 2 title: SMS 3 + description: "How to set up SMS notifications in OpenStatus to get alerts when your synthetic check fail" 4 + 3 5 --- 4 6 5 7 When you subscribe to a paid plan you can receive SMS notifications when your
+2
apps/docs/src/content/docs/alerting/providers/telegram.mdx
··· 1 1 --- 2 2 title: Telegram 3 + description: "How to set up Telegram notifications in OpenStatus to get alerts when your synthetic check fail" 4 + 3 5 --- 4 6 5 7 ๐Ÿšง Coming soon ๐Ÿšง
+1 -1
apps/docs/src/content/docs/cli/commands/monitors.mdx
··· 1 1 --- 2 2 title: Monitors 3 + description: "Manage your monitors in OpenStatus from the command line" 3 4 --- 4 5 5 6 The monitors command is used to manage your monitors. You trigger, view and list your monitors using this command. ··· 32 33 ```bash 33 34 openstatus monitors trigger <monitor-id> 34 35 ``` 35 -
+2 -1
apps/docs/src/content/docs/cli/commands/run.mdx
··· 1 1 --- 2 2 title: Run 3 + description: "How to run a list of synthetic checks in OpenStatus from the command line" 3 4 --- 4 5 5 6 This command is used to run a list of synthetic check. ··· 21 22 22 23 ### Options 23 24 24 - - `--config` - Path to the config file. Default is `config.openstatus.yaml`. 25 + - `--config` - Path to the config file. Default is `config.openstatus.yaml`.
+2 -1
apps/docs/src/content/docs/cli/commands/whoami.mdx
··· 1 1 --- 2 2 title: Whoami 3 + description: "How to check the currently authenticated user in OpenStatus with the whoami command" 3 4 --- 4 5 5 - 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. 6 + 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.
+2 -1
apps/docs/src/content/docs/cli/getting-started.mdx
··· 1 1 --- 2 2 title: Getting Started 3 + description: "Get started with OpenStatus CLI and start triggering your synthetic checks from your terminal" 3 4 --- 4 5 5 6 import { Image } from 'astro:assets'; ··· 49 50 50 51 ```bash 51 52 openstatus [COMMAND] --access-token your-api-token 52 - ``` 53 + ```
+1
apps/docs/src/content/docs/incident/incident-detail.mdx
··· 1 1 --- 2 2 title: Incident Detail 3 + description: "Discover the incident details in OpenStatus" 3 4 order: 2 4 5 --- 5 6
+1 -1
apps/docs/src/content/docs/incident/overview.mdx
··· 1 1 --- 2 2 title: Overview 3 - description: "How incident are created, how to acknowledge, and resolve them" 3 + description: "Discover what is an incident in OpenStatus" 4 4 --- 5 5 6 6
+1
apps/docs/src/content/docs/incident/work-with-incident.mdx
··· 1 1 --- 2 2 title: Work with Incidents 3 + description: "How to acknowledge and resolve incidents in OpenStatus" 3 4 --- 4 5 5 6 An incident can have the following states:
+1 -2
apps/docs/src/content/docs/monitoring/clone-monitor.mdx
··· 1 1 --- 2 2 title: How to clone a monitor? 3 - description: "How to clone your first monitor with OpenStatus.dev" 3 + description: "How to clone a monitor with OpenStatus" 4 4 --- 5 5 6 6 import { Image } from 'astro:assets'; ··· 15 15 src={monitorDetail} 16 16 alt="Charts with status code and response time" 17 17 /> 18 -
+1 -1
apps/docs/src/content/docs/monitoring/create-monitor.mdx
··· 1 1 --- 2 2 title: How to create a monitor? 3 - description: "How to create your first monitor with OpenStatus.dev" 3 + description: "How to create your first monitor with OpenStatus" 4 4 --- 5 5 6 6 import { Image } from 'astro:assets';
+1 -2
apps/docs/src/content/docs/monitoring/customization/assertions.mdx
··· 1 1 --- 2 2 title: Assertions 3 - description: "How to monitor your HTTP services with OpenStatus.dev" 3 + description: "How to set up assertions for your synthetic checks in OpenStatus" 4 4 --- 5 5 6 6 ··· 38 38 Define the **body string** you want to check for. 39 39 40 40 Supports `Equal`, `Not equal`, `Contains`, `Does not Contain`, `Empty`, `Not empty`, `Greater than`, `Less than`, `Greater than or equal`, `Less than or equal` assertions. 41 -
+2 -2
apps/docs/src/content/docs/monitoring/customization/frequency.mdx
··· 1 1 --- 2 2 title: Frequency 3 - description: "How to monitor your HTTP services with OpenStatus.dev" 3 + description: "How to change the frequency of your synthetic checks in OpenStatus" 4 4 --- 5 5 6 6 By default, OpenStatus.dev will check your service every 30 minutes. ··· 16 16 - Every 5 minutes 17 17 - Every 10 minutes 18 18 - Every 30 minutes 19 - - Every 1 hour 19 + - Every 1 hour
+2 -1
apps/docs/src/content/docs/monitoring/customization/notification.mdx
··· 1 1 --- 2 2 title: Notifications 3 + description: "How to set up notifications for your synthetic checks in OpenStatus" 3 4 --- 4 5 import { Image } from 'astro:assets'; 5 6 import { Aside} from '@astrojs/starlight/components'; ··· 22 23 23 24 <Aside> 24 25 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. 25 - </Aside> 26 + </Aside>
+2 -2
apps/docs/src/content/docs/monitoring/customization/regions.mdx
··· 1 1 --- 2 2 title: Regions 3 - description: "How to monitor your HTTP services with OpenStatus.dev" 3 + description: "How to change the regions for your synthetic checks in OpenStatus" 4 4 --- 5 5 6 6 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 57 58 58 Oceania 59 59 60 - - Sydney, Australia ๐Ÿ‡ฆ๐Ÿ‡บ (free) 60 + - Sydney, Australia ๐Ÿ‡ฆ๐Ÿ‡บ (free)
+2 -2
apps/docs/src/content/docs/monitoring/customization/timing.mdx
··· 1 1 --- 2 2 title: Timing 3 - description: "How to monitor your HTTP services with OpenStatus.dev" 3 + description: "How to set up timing threshold for your synthetic checks in OpenStatus" 4 4 --- 5 5 6 6 By default, OpenStatus will timeout after `45s` but you can set a custom timeout (max. `45s`). 7 7 8 8 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. 9 9 10 - To change assertions for your monitors: _Select a monitor &rarr; Settings &rarr; Timing & Assertions_. 10 + To change assertions for your monitors: _Select a monitor &rarr; Settings &rarr; Timing & Assertions_.
+1
apps/docs/src/content/docs/monitoring/group-monitor-tag.mdx
··· 1 1 --- 2 2 title: How to group your monitors 3 + description: "How to group your monitors in OpenStatus to manage them more efficiently" 3 4 --- 4 5 5 6 import { Image } from 'astro:assets';
+1 -1
apps/docs/src/content/docs/monitoring/monitor-data-collected.mdx
··· 1 1 --- 2 2 title: Monitor Data Points 3 - description: "Monitor metrics are the data points that are collected by the monitor during the check." 3 + description: "Monitor metrics are the data points that are collected by the monitor during the check in OpenStatus." 4 4 --- 5 5 6 6 import { Image } from 'astro:assets';
+2 -3
apps/docs/src/content/docs/monitoring/overview.mdx
··· 28 28 <CardGrid> 29 29 <LinkCard 30 30 title="HTTP Monitor" 31 - href="/type/http" 31 + href="/monitoring/type/http" 32 32 /> 33 33 <LinkCard 34 34 title="TCP Monitor" 35 - href="/type/tcp" 35 + href="/monitoring/type/tcp" 36 36 /> 37 37 </CardGrid> 38 -
+1 -1
apps/docs/src/content/docs/monitoring/type/http.mdx
··· 1 1 --- 2 2 title: HTTP 3 - description: "How to monitor your HTTP services with OpenStatus.dev" 3 + description: "How to monitor your HTTP services with OpenStatus" 4 4 --- 5 5 import { Image } from 'astro:assets'; 6 6
+1 -1
apps/docs/src/content/docs/monitoring/type/tcp.mdx
··· 1 1 --- 2 2 title: TCP 3 - description: "How to monitor your TCP services with OpenStatus.dev" 3 + description: "How to monitor your TCP services with OpenStatus" 4 4 --- 5 5 6 6 import { Image } from 'astro:assets';
+1
apps/docs/src/content/docs/status-page/advanced/badge.mdx
··· 1 1 --- 2 2 title: Badge 3 + description: "How to embed the status page badge on your website or GitHub README" 3 4 --- 4 5 5 6 You can embed the status page badge on your website or GitHub README to show the
+1
apps/docs/src/content/docs/status-page/advanced/custom-domain.mdx
··· 1 1 --- 2 2 title: Custom Domain 3 + description: "How to connect a custom domain to your status page in OpenStatus" 3 4 --- 4 5 5 6 import { Aside } from '@astrojs/starlight/components';
+1
apps/docs/src/content/docs/status-page/advanced/description.mdx
··· 1 1 --- 2 2 title: Description 3 + description: "How to set a custom description for your status page in OpenStatus" 3 4 --- 4 5 5 6 import { Image } from 'astro:assets';
+1
apps/docs/src/content/docs/status-page/advanced/icon.mdx
··· 1 1 --- 2 2 title: Icon 3 + description: "How to set a custom icon for your status page in OpenStatus" 3 4 --- 4 5 5 6 import { Image } from 'astro:assets';
+1
apps/docs/src/content/docs/status-page/advanced/monitors.mdx
··· 1 1 --- 2 2 title: Monitors 3 + description: "How to connect your monitors for your status page in OpenStatus" 3 4 --- 4 5 5 6 Connect your created monitors to your status page to display the current status of your services.
+1
apps/docs/src/content/docs/status-page/advanced/password.mdx
··· 1 1 --- 2 2 title: Password protection 3 + description: "How to password protect your status page in OpenStatus" 3 4 --- 4 5 5 6 import { Aside } from '@astrojs/starlight/components';
+2 -1
apps/docs/src/content/docs/status-page/advanced/widget.mdx
··· 1 1 --- 2 2 title: Public Status Widget 3 + description: "How to embed the public status widget in your React application" 3 4 --- 4 5 import { Aside } from '@astrojs/starlight/components'; 5 6 ··· 14 15 <Aside> 15 16 We have released an `@openstatus/react` npm package that allows you to easily 16 17 integrate the pre-typed status into your React projects or use the default 17 - widget. Read more [here](/packages/react). 18 + widget. Read more [here](/tools/react). 18 19 </Aside> 19 20 20 21 The response is a JSON object with the following structure:
+1
apps/docs/src/content/docs/status-page/create-status-page.mdx
··· 1 1 --- 2 2 title: How to create a status page? 3 + description: "How to create a status page in OpenStatus" 3 4 --- 4 5 5 6 import { Image } from 'astro:assets';
+2 -1
apps/docs/src/content/docs/status-page/overview.mdx
··· 1 1 --- 2 2 title: Status page 3 + description: "Discover what is a status page in OpenStatus" 3 4 --- 4 5 import { Image } from 'astro:assets'; 5 6 ··· 18 19 services. It shows the current status of your services and the history of 19 20 incidents. 20 21 21 - You can create a status page with OpenStatus.dev and display the status of your synthetic checks. 22 + You can create a status page with OpenStatus and display the status of your synthetic checks. 22 23 23 24 You can see our own status page at [https://status.openstatus.dev](https://status.openstatus.dev). 24 25
+1 -1
apps/docs/src/content/docs/tools/terraform.mdx
··· 1 1 --- 2 2 title: Terraform Provider 3 3 description: 4 - "Use OpenStatus Terraform provider to manage your monitors and status page." 4 + "Use OpenStatus Terraform provider to manage your monitors and status page." 5 5 --- 6 6 7 7 Here you can find the official OpenStatus Terraform provider. This provider
+4 -4
apps/web/src/content/posts/reflecting-1-year-building-openstatus.mdx
··· 46 46 As we progressed, we talked to a lot of users, VC. We explored various directions, sometimes feeling a bit lost in the sea of possibilities: 47 47 48 48 1. **Serverless monitoring**: Given that most of our users were Vercel customers, we considered specializing in this area. 49 - 2. **Incident management**: Inspired by products like [incident.io](http://incident.io/), we contemplated starting with status pages and expanding into incident management. However, we realized this would target larger, Series B+ startups, involving longer sales processes and diverging from our core audience of small teams from bootstrapped businesses or Series A startups. 49 + 2. **Incident management**: Inspired by products like [incident.io](https://incident.io/), we contemplated starting with status pages and expanding into incident management. However, we realized this would target larger, Series B+ startups, involving longer sales processes and diverging from our core audience of small teams from bootstrapped businesses or Series A startups. 50 50 3. **AI-enhanced alerting systems**: We briefly considered focusing on our product's alerting capabilities and incorporating AI for smart alerts. In retrospect, this seemed more like an attempt to capitalize on the AI trend rather than a strategic decision. 51 51 4. **Real User Monitoring (RUM)**: We implemented this feature, but after discussions, we recognized the need to focus on our core strength: synthetic monitoring. 52 52 ··· 72 72 73 73 ### Riding the OSS train 74 74 75 - We started at the right time where lots of Open-Source Software companies like our friends at [papermark.io](http://papermark.io?ref=openstatus.dev), [uninbox.com](http://uninbox.com?ref=openstatus.dev) or [documenso.com](http://documenso.com?ref=openstatus.dev) flourished at the same time and made it into the oss-friends list by [formbricks.com](http://formbricks.com?ref=openstatus.dev). 75 + We started at the right time where lots of Open-Source Software companies like our friends at [papermark.io](https://papermark.io?ref=openstatus.dev), [uninbox.com](http://uninbox.com?ref=openstatus.dev) or [documenso.com](http://documenso.com?ref=openstatus.dev) flourished at the same time and made it into the oss-friends list by [formbricks.com](http://formbricks.com?ref=openstatus.dev). 76 76 77 77 **Sometimes, you have to be lucky! We were fortunate to be in the right place at the right time, gaining the visibility that helped set us apart.** 78 78 ··· 109 109 110 110 ### Tools and Components 111 111 112 - Additionally, creating tools and components people love is a great way to draw attention and leverage SEO: [time.openstatus.dev](http://time.openstatus.dev) - a shadcn time picker drives 3k visitors per month organically. Same goal is with [data-table.openstatus.dev](http://data-table.openstatus.dev) - an extensive data-table for your realtime data. 112 + Additionally, creating tools and components people love is a great way to draw attention and leverage SEO: [time.openstatus.dev](https://time.openstatus.dev) - a shadcn time picker drives 3k visitors per month organically. Same goal is with [data-table.openstatus.dev](https://data-table.openstatus.dev) - an extensive data-table for your realtime data. 113 113 114 114 > We want to show users we are here to build with and for you. And of course in the open. 115 115 ··· 208 208 To infinity and beyond ๐Ÿš€ 209 209 210 210 Want to join us on this journey? [Star us on GitHub](https://www.github.com/openstatusHQ/openstatus)! ๐ŸŒŸ 211 - Or create an account on [Openstatus](https://www.openstatus.dev/app/login) and start monitoring your services today! 211 + Or create an account on [Openstatus](https://www.openstatus.dev/app/login) and start monitoring your services today!
+2 -2
apps/web/src/content/posts/secure-api-with-unkey.mdx
··· 66 66 ``` 67 67 68 68 To test key creation, you can simply go to the 69 - [Unkey Dashboard](http://unkey.dev/app) and create an API key manually instead 69 + [Unkey Dashboard](https://unkey.dev/app) and create an API key manually instead 70 70 of using the SDK. The SDK is useful once you want your users to create API keys 71 71 programmatically. 72 72 ··· 203 203 user, not the infrastructure behind it. We also get **key verification 204 204 insights** out of the box and can target specific users based on their usage. 205 205 206 - [@chronark\_](http://twitter.com/chronark_) has recently published an 206 + [@chronark\_](https://twitter.com/chronark_) has recently published an 207 207 [`@unkey/hono`](https://docs.unkey.dev/libraries/ts/hono) package that uses a 208 208 similar implementation under the hood, reducing some boilerplate code for you. 209 209 Highly recommend checking it out if you are using Hono.js.
+1 -1
apps/web/src/content/posts/the-first-48-hours.mdx
··· 29 29 We conducted a DDOS attack on Vercel's firewalls from Upstash servers because we 30 30 where pining every single vercel region for every monitor (18 \* 315 = 5.670) 31 31 more or less at once. Before considering the removal of 32 - [QStash](http://upstash.com/qstash?ref=openstatus), we implemented a hotfix to 32 + [QStash](https://upstash.com/qstash?ref=openstatus), we implemented a hotfix to 33 33 introduce random delays of 0 to 180 seconds between each ping. This prevented us 34 34 from overwhelming Vercel with simultaneous requests, significantly reducing the 35 35 number of retries on QStash. As a result of these measures, we now have a