Skip to content

Open-source status page, incident response and uptime monitoring

📝 more content (#1110)

Thibault Le Ouay80379c8cb5f0
diff --git a/apps/docs/astro.config.mjs b/apps/docs/astro.config.mjs
index af3ccacba..b98f76644 100644
--- a/apps/docs/astro.config.mjs
+++ b/apps/docs/astro.config.mjs
@@ -20,11 +20,13 @@ export default defineConfig({
social: {
github: "https://github.com/openstatusHQ/openstatus",
blueSky: "https://bsky.app/profile/openstatus.dev",
+ discord: "https://www.openstatus.dev/discord",
},
components: {
SiteTitle: "./src/components/SiteTitle.astro",
Head: "./src/components/Head.astro",
Hero: "./src/components/Hero.astro",
+ Footer: "./src/components/Footer.astro",
},
editLink: {
baseUrl: "https://github.com/openstatusHQ/openstatus/app/docs",
@@ -38,7 +40,7 @@ export default defineConfig({
starlightSidebarTopics([
{
label: "Documentation",
- link: "/getting-started/introduction",
+ link: "/",
id: "docs",
icon: "open-book",
items: [
@@ -63,6 +65,10 @@ export default defineConfig({
label: "View your monitor data",
slug: "monitoring/monitor-data-collected",
},
+ {
+ label: "Group your monitors",
+ slug: "monitoring/group-monitor-tag",
+ },
{
label: "Monitor Types",
collapsed: true,
@@ -108,6 +114,7 @@ export default defineConfig({
},
{
label: "Status Page",
+ collapsed: true,
items: [
{ label: "Overview", slug: "status-page/overview" },
@@ -130,6 +137,7 @@ export default defineConfig({
},
{
label: "Incidents",
+ collapsed: true,
items: [
{ label: "Overview", slug: "incident/overview" },
{
@@ -145,6 +153,7 @@ export default defineConfig({
},
{
label: "Alerting",
+ collapsed: true,
items: [
{ label: "Overview", slug: "alerting/overview" },
{
@@ -157,11 +166,13 @@ export default defineConfig({
],
},
{
- label: "Tools",
+ label: "Developer Tools",
+ collapsed: true,
autogenerate: { directory: "tools" },
},
{
label: "Support",
+ collapsed: true,
items: [
{
label: "Help",
diff --git a/apps/docs/src/assets/monitor/assertions.png b/apps/docs/src/assets/monitor/assertions.png
new file mode 100644
index 000000000..0f26cc025
Binary files /dev/null and b/apps/docs/src/assets/monitor/assertions.png differ
diff --git a/apps/docs/src/assets/monitor/create-tag.png b/apps/docs/src/assets/monitor/create-tag.png
new file mode 100644
index 000000000..7984f1916
Binary files /dev/null and b/apps/docs/src/assets/monitor/create-tag.png differ
diff --git a/apps/docs/src/assets/monitor/filter-tag.png b/apps/docs/src/assets/monitor/filter-tag.png
new file mode 100644
index 000000000..abd612a97
Binary files /dev/null and b/apps/docs/src/assets/monitor/filter-tag.png differ
diff --git a/apps/docs/src/assets/monitor/notifications.png b/apps/docs/src/assets/monitor/notifications.png
new file mode 100644
index 000000000..7343a6595
Binary files /dev/null and b/apps/docs/src/assets/monitor/notifications.png differ
diff --git a/apps/docs/src/components/Footer.astro b/apps/docs/src/components/Footer.astro
new file mode 100644
index 000000000..9b205b8fb
--- /dev/null
+++ b/apps/docs/src/components/Footer.astro
@@ -0,0 +1,52 @@
+---
+import type { Props } from "@astrojs/starlight/props";
+
+import EditLink from "@astrojs/starlight/components/EditLink.astro";
+import LastUpdated from "@astrojs/starlight/components/LastUpdated.astro";
+import Pagination from "@astrojs/starlight/components/Pagination.astro";
+---
+
+<footer class="sl-flex">
+ <div class="meta sl-flex">
+ <EditLink {...Astro.props} />
+ <LastUpdated {...Astro.props} />
+ </div>
+ <Pagination {...Astro.props} />
+ <div class="github">
+ <span>Show your support! Star us on GitHub ⭐️</span>
+ <a class="github-button" href="https://github.com/openstatusHQ/openstatus" data-color-scheme="no-preference: light; light: light; dark: light;" data-icon="octicon-star" data-size="large" data-show-count="true" aria-label="Star openstatusHQ/openstatus on GitHub">Star</a>
+ </div>
+</footer>
+
+<style>
+ footer {
+ flex-direction: column;
+ gap: 1.5rem;
+ }
+ .meta {
+ gap: 0.75rem 3rem;
+ justify-content: space-between;
+ flex-wrap: wrap;
+ margin-top: 3rem;
+ font-size: var(--sl-text-sm);
+ color: var(--sl-color-gray-3);
+ }
+ .meta > :global(p:only-child) {
+ margin-inline-start: auto;
+ }
+
+ .github {
+ align-items: center;
+ justify-content: center;
+ gap: 0.5em;
+ margin: 2rem auto;
+ font-size: var(--sl-text-sm);
+ text-decoration: none;
+ display: flex;
+ flex-direction: column;
+ }
+ .github span {
+ font-size: var(--sl-text-sm);
+ cursor: default;
+ }
+</style>
\ No newline at end of file
diff --git a/apps/docs/src/components/Head.astro b/apps/docs/src/components/Head.astro
index edaec6b99..b7bd023ae 100644
--- a/apps/docs/src/components/Head.astro
+++ b/apps/docs/src/components/Head.astro
@@ -15,4 +15,7 @@ const url = `https://openstatus.dev/api/og?title=${siteTitle}&description=${titl
<script is:inline defer data-domain="docs.openstatus.dev" src="https://plausible.io/js/script.js" />
<!-- REMINDER: prevent unexpected font flashes for our 'OpenStatus' logo on each page load -->
-<link rel="preload" href="/fonts/CalSans-SemiBold.ttf" as="font" type="font/ttf" crossorigin>
\ No newline at end of file
+<link rel="preload" href="/fonts/CalSans-SemiBold.ttf" as="font" type="font/ttf" crossorigin>
+<script defer async src="https://buttons.github.io/buttons.js" />
+
+
diff --git a/apps/docs/src/content/docs/getting-started/introduction.mdx b/apps/docs/src/content/docs/getting-started/introduction.mdx
index 4730f89aa..3a977d350 100644
--- a/apps/docs/src/content/docs/getting-started/introduction.mdx
+++ b/apps/docs/src/content/docs/getting-started/introduction.mdx
@@ -15,7 +15,7 @@ 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 begin monitoring your services in seconds.
### Self Hosted version
diff --git a/apps/docs/src/content/docs/help/support.mdx b/apps/docs/src/content/docs/help/support.mdx
index c4212dabb..0d9832135 100644
--- a/apps/docs/src/content/docs/help/support.mdx
+++ b/apps/docs/src/content/docs/help/support.mdx
@@ -1,5 +1,5 @@
---
-title: Support
+title: Need help?
description: "We're always here to help."
---
diff --git a/apps/docs/src/content/docs/index.mdx b/apps/docs/src/content/docs/index.mdx
index 99d8d1969..26374d1b8 100644
--- a/apps/docs/src/content/docs/index.mdx
+++ b/apps/docs/src/content/docs/index.mdx
@@ -6,7 +6,7 @@ topic: docs
next: false
hero:
title: Welcome to OpenStatus
- tagline: Explore our documentation to get started with OpenStatus
+ tagline: Explore our documentation to get started with OpenStatus and start monitoring your services.
---
import { Card, CardGrid, LinkCard } from '@astrojs/starlight/components';
diff --git a/apps/docs/src/content/docs/monitoring/customization/assertions.mdx b/apps/docs/src/content/docs/monitoring/customization/assertions.mdx
index 347d4343a..2186e935d 100644
--- a/apps/docs/src/content/docs/monitoring/customization/assertions.mdx
+++ b/apps/docs/src/content/docs/monitoring/customization/assertions.mdx
@@ -3,6 +3,18 @@ title: Assertions
description: "How to monitor your HTTP services with OpenStatus.dev"
---
+
+import { Image } from 'astro:assets';
+
+import Assertions from '../../../../assets/monitor/assertions.png';
+
+ <Image
+ src={Assertions}
+ alt="Monitor assertions"
+ />
+
+
+
By default we expect the endpoint to return a `200` status code. If you want to check for a different status code you can go to to the `Assertions` tab and add a new assertion.
We support **status code**, **header** and **body string** assertions.
diff --git a/apps/docs/src/content/docs/monitoring/customization/notification.mdx b/apps/docs/src/content/docs/monitoring/customization/notification.mdx
index 32d0be3d1..c4e1f2355 100644
--- a/apps/docs/src/content/docs/monitoring/customization/notification.mdx
+++ b/apps/docs/src/content/docs/monitoring/customization/notification.mdx
@@ -1,5 +1,25 @@
---
-title: Notification
+title: Notifications
---
+import { Image } from 'astro:assets';
+import { Aside} from '@astrojs/starlight/components';
+import Notification from '../../../../assets/monitor/notifications.png';
+
+ <Image
+ src={Notification}
+ alt="Monitor notifications"
+ />
+
+
+If you want to receive notifications when your monitor fails, you can connect it to a notification channel.
+
+To connect your monitor to a notification channel, _Select a monitor &rarr; Settings &rarr; Notifications_.
+
+You will have the list of available notification channels. You can connect your monitor to one or multiple notification channels.
+
+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>
\ No newline at end of file
diff --git a/apps/docs/src/content/docs/monitoring/group-monitor-tag.mdx b/apps/docs/src/content/docs/monitoring/group-monitor-tag.mdx
new file mode 100644
index 000000000..950fa16c8
--- /dev/null
+++ b/apps/docs/src/content/docs/monitoring/group-monitor-tag.mdx
@@ -0,0 +1,29 @@
+---
+title: How to group your monitors
+---
+
+import { Image } from 'astro:assets';
+
+import createTag from '../../../assets/monitor/create-tag.png'
+import filterTag from '../../../assets/monitor/filter-tag.png'
+
+If you have multiple monitors that you want to group together, you can do so by creating a tag. Tags help you organize your monitors and manage them more efficiently.
+
+### Create a tag
+
+You can create a tag by going to settings tab of your monitor and adding a new tag.
+
+ <Image
+ src={createTag}
+ alt="OpenStatus create monitor tag"
+ />
+
+
+### Filter monitors by Tags
+
+Once you have created tags, you can filter your monitors by tags. This helps you to quickly find the monitors you are looking for.
+
+ <Image
+ src={filterTag}
+ alt="OpenStatus filter by tag"
+ />
diff --git a/apps/server/src/v1/index.ts b/apps/server/src/v1/index.ts
index 6dee2801a..dace22240 100644
--- a/apps/server/src/v1/index.ts
+++ b/apps/server/src/v1/index.ts
@@ -44,7 +44,7 @@ api.doc("/openapi", {
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. ",
+ "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. \n\n To get started you need to create an account on https://www.openstatus.dev/ and create an api token in your settings.",
},
});