Skip to content

Commit

Permalink
🚀 more content (#1105)
Browse files Browse the repository at this point in the history
* 🚀 more content

* ci: apply automated fixes

* 🚀 more content

* 🚀 more content

* ci: apply automated fixes

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
  • Loading branch information
thibaultleouay and autofix-ci[bot] authored Nov 20, 2024
1 parent 1b7ac9e commit cadbbc2
Show file tree
Hide file tree
Showing 15 changed files with 47 additions and 24 deletions.
2 changes: 1 addition & 1 deletion apps/docs/src/content/docs/guides/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@ sidebar:

Here's some content for the getting started with OpenStatus.

- [How to use OpenStatus to test latency in GitHub Actions](/guides/test-latency-cf-workers-in-github-actions)
- [How to deploy your own probe to Koyeb](/guides/how-deploy-checker-koyeb/)

- [Deploy your own Status Page to Cloudflare Pages](/guides/how-deploy-status-page-cf-pages)
14 changes: 12 additions & 2 deletions apps/docs/src/content/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ hero:
tagline: Explore our documentation to get started with OpenStatus
---

import { Card, CardGrid } from '@astrojs/starlight/components';
import { Card, CardGrid, LinkCard } from '@astrojs/starlight/components';
import "../../custom.css"

<CardGrid >
Expand All @@ -20,7 +20,7 @@ import "../../custom.css"
Read our <a href="guides/introduction/">guides</a> to discover what you can do with OpenStatus
</Card>
<Card title="CLI" icon="seti:shell">
Learn more about our [CLI](/cli) to manage and run your synthetic check.
Learn more about our [CLI](/cli/getting-started) to manage and run your synthetic check.
</Card>
<Card title="API Reference" icon="puzzle">
Use our <a href="https://api.openstatus.dev/v1">API</a> to build amazing things on top of OpenStatus
Expand All @@ -29,3 +29,13 @@ import "../../custom.css"
Checkout our [GitHub repository](https://www.github.com/openstatushq/openstatus) to contribute or report issues.
</Card>
</CardGrid>


## Join the community

Join the commmunity to get help, share your ideas or just to say hi.

<CardGrid>
<LinkCard href="https://www.openstatus.dev/discord" title="Discord"/>
<LinkCard href="https://bsky.app/profile/openstatus.dev" title="Bluesky" />
</CardGrid>
18 changes: 9 additions & 9 deletions apps/docs/src/content/docs/monitoring/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,25 +21,25 @@ You can create monitors in our dashboard, with the [API](https://api.openstatus.
A monitor is a job that runs periodically or on-demand and checks the status of a service. It
can be a website, an API, or anything else that can be checked automatically.

We will make a request to your endpoint on a regular schedule and record the results.
We will make a request to your endpoint on a regular schedule, or on-demand and record the results.

### Quick Links

<CardGrid>
<LinkCard
title="Assertions"
<LinkCard
title="Assertions"
href="/monitoring/customization/assertions"
/>
<LinkCard
title="Frequency"
<LinkCard
title="Frequency"
href="/monitoring/customization/frequency"
/>
<LinkCard
title="Regions"
<LinkCard
title="Regions"
href="/monitoring/customization/regions"
/>
<LinkCard
title="Timing"
<LinkCard
title="Timing"
href="/monitoring/customization/timing"
/>
</CardGrid>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,11 @@ To change monitors for a status page: _Select a status page &rarr; Settings &rar
By default, we share the number of total requests and the number of failed request with the total uptime of the last 45 days. If you want to hide the values, you can do so by toggeling the setting.

{/* TODO: update after OPE-427 */}
To change the visibility of the values: _Select a status page &rarr; Settings &rarr; Advanced_.
To change the visibility of the values: _Select a status page &rarr; Settings &rarr; Advanced_.


### Public monitors

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.
2 changes: 1 addition & 1 deletion apps/docs/src/content/docs/status-page/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -57,4 +57,4 @@ You can also customize the size of the badge by adding a `size` parameter:

## Add monitors metrics 📊

If you make your <a href="/synthetic/features/monitor#public-monitor">monitor public</a>, you can display the metrics on your status page.
If you make your <a href="/status-page/customization/monitors">monitor public</a>, you can display the metrics on your status page.
6 changes: 6 additions & 0 deletions apps/server/src/v1/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,12 @@ api.doc("/openapi", {
info: {
version: "1.0.0",
title: "OpenStatus API",
contact: {
email: "[email protected]",
url: "https://www.openstatus.dev",
},
description:
"OpenStatus is a open-source synthetic monitoring tool that allows you to monitor your website and API's uptime, latency, and more. \n\n The OpenStatus API allows you to interact with the OpenStatus platform programmatically. ",
},
});

Expand Down
2 changes: 1 addition & 1 deletion apps/web/src/app/(content)/features/monitoring/page.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ export default function FeaturePage() {
action={
<div className="mt-2">
<Button variant="outline" className="rounded-full" asChild>
<Link href="https://docs.openstatus.dev/guides/test-latency-cf-workers-in-github-actions">
<Link href="https://docs.openstatus.dev/cli/getting-started">
How-to
</Link>
</Button>
Expand Down
2 changes: 1 addition & 1 deletion apps/web/src/components/layout/status-widget-suspense.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ export function StatusWidgetContainer(props: StatusWidgetProps) {
<Button variant="link" size="sm" asChild>
<a
target="_blank"
href="https://docs.openstatus.dev/packages/react"
href="https://docs.openstatus.dev/tools/react/"
rel="noreferrer"
>
Install your own <ExternalLink className="ml-1 h-3 w-3" />
Expand Down
2 changes: 1 addition & 1 deletion apps/web/src/content/changelog/check-run-api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ We have added a new API to launch a check with OpenStatus. You can now test your

It's useful if you want to integrate OpenStatus with your CI/CD pipeline.

You can read the [API documentation](https://docs.openstatus.dev/api-reference/check/post-check) or our guide to integrate it in [GitHub Actions](https://docs.openstatus.dev/guides/test-latency-cf-workers-in-github-actions) to get started.
You can read the [API documentation](https://api.openstatus.dev/v1#tag/monitor/POST/monitor/:id/trigger).

2 changes: 1 addition & 1 deletion apps/web/src/content/changelog/checker-playground.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,4 @@ curl --request POST \
```

Read more about the
[Checker API](https://docs.openstatus.dev/api-reference/checker) in our docs.
[Checker API](https://api.openstatus.dev/v1#tag/monitor/POST/monitor/:id/run) in our docs.
2 changes: 1 addition & 1 deletion apps/web/src/content/changelog/golang-monitor-checker.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ In addition to that, we have renamed the **Incidents** to **Status Reports** to
easily distinguish between internal incidents and external reports.

> The API endpoint has also moved from `/v1/incidents` to `/v1/status_reports`.
> Read more in the [docs](https://docs.openstatus.dev/getting-started/incident).
> Read more in the [docs](https://docs.openstatus.dev/incident/overview).
2 changes: 1 addition & 1 deletion apps/web/src/content/changelog/status-widget.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ $ curl https://api.openstatus.dev/public/status/:slug
```

You can find the documentation
[here](https://docs.openstatus.dev/api-server/status-widget).
[here](https://docs.openstatus.dev/tools/status-widget).
Original file line number Diff line number Diff line change
Expand Up @@ -128,5 +128,5 @@ application other than Next.js, it may not be the best option.

We are still using it for our frontend.

Create an account on [OpenStatus](https://www.openstatus.dev/sign-up?ref=blog3)
Create an account on [OpenStatus](https://www.openstatus.dev/app/login?ref=blog3)
to start monitoring our website and managing your incidents for free.
4 changes: 2 additions & 2 deletions apps/web/src/content/posts/pricing-update-july-2024.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ image: /assets/posts/pricing-update-july-2024/pricing.png

It's been six months since our last pricing update, and a lot has changed. We've shipped a lot of new features since January significantly improving our product, e.g :
- [35 regions available](/changelog/more-regions),
- [Password protected status page](changelog/password-protected-status-page),
- [Password protected status page](/changelog/password-protected-status-page),
- [PagerDuty integrations](/changelog/pagerduty-integration)


Expand All @@ -35,7 +35,7 @@ We currently support `35 regions`, and plans to expand to `41 regions` soon.

Our main competitor, Datadog, only covers `29 regions`. They also charge per request `$7.20 per 10k requests`, which can quickly add up if you're monitoring multiple services.

We took a completly different approach we are charging per monitors instead of requests. You can still run some checks via our [API](https://docs.openstatus.dev/api-reference/check/post-check) if you need to.
We took a completly different approach we are charging per monitors instead of requests. You can still run some checks via our [API](https://api.openstatus.dev/v1#tag/monitor/POST/monitor/:id/trigger) if you need to.

This means you can set a fixed number of monitors without worrying about the number of requests our price is fixed.

Expand Down
2 changes: 1 addition & 1 deletion apps/web/src/content/posts/secure-api-with-unkey.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ with [bun](https://bun.sh) via `bun run src/index.ts`.
> [`@hono/zod-openapi`](https://github.com/honojs/middleware/tree/main/packages/zod-openapi)
> plugin to generate an OpenAPI spec out of the box. Read more about the
> supported endpoints in our
> [docs](https://docs.openstatus.dev/rest-api/openapi).
> [docs](https://api.openstatus.dev/v1).
## Conclusion

Expand Down

0 comments on commit cadbbc2

Please sign in to comment.