Skip to content

Open-source status page, incident response and uptime monitoring

chore: update faq (#617)

Maximilian Kaskeecade014a818
diff --git a/apps/web/src/app/play/page.tsx b/apps/web/src/app/play/page.tsx
index 1ba3c0ce0..ecd6938c8 100644
--- a/apps/web/src/app/play/page.tsx
+++ b/apps/web/src/app/play/page.tsx
@@ -1,13 +1,9 @@
import type { Metadata } from "next";
-import Link from "next/link";
-import type { LucideIcon } from "lucide-react";
import { Clock, FileCode, Gauge, Palette, PanelTop } from "lucide-react";
-import { Button } from "@openstatus/ui";
-
-import { Shell } from "@/components/dashboard/shell";
import { BackButton } from "@/components/layout/back-button";
-import { cn } from "@/lib/utils";
+import type { CardProps } from "@/components/play/card";
+import { Card } from "@/components/play/card";
import {
defaultMetadata,
ogMetadata,
@@ -19,12 +15,12 @@ export const metadata: Metadata = {
title: "Free Tools ",
openGraph: {
...ogMetadata,
- title: "Free Tools | OpenStatus",
+ title: "Free Tools",
url: "https://www.openstatus.dev/play",
},
twitter: {
...twitterMetadata,
- title: "Free Tools | OpenStatus",
+ title: "Free Tools",
},
};
@@ -48,66 +44,10 @@ export default async function PlayPage() {
);
}
-interface CardProps extends React.HTMLAttributes<HTMLDivElement>, Playground {}
-
-function Card({
- label,
- description,
- href,
- variant = "default",
- icon,
- className,
- ...props
-}: CardProps) {
- const buttonVariant = variant === "default" ? "outline" : "default";
- const shellClassName =
- variant === "default" ? "" : "bg-accent text-accent-foreground";
- const Icon = icon;
-
- const isExternal = href.startsWith("http");
- const externalProps = isExternal
- ? { target: "_blank", rel: "noreferrer" }
- : {};
-
- return (
- <Shell
- className={cn(
- "group flex flex-col gap-3 hover:shadow",
- shellClassName,
- className,
- )}
- {...props}
- >
- <div className="flex-1 space-y-2">
- <h2 className={cn("font-cal text-xl")}>{label}</h2>
- <p className="text-muted-foreground">{description}</p>
- </div>
- <div className="flex items-center justify-between">
- <Button variant={buttonVariant} className="rounded-full" asChild>
- <Link href={href} {...externalProps}>
- Learn more
- </Link>
- </Button>
- <div className="border-border bg-background rounded-full border p-2 transition-transform duration-200 group-hover:-rotate-12">
- <Icon className="text-muted-foreground h-5 w-5" />
- </div>
- </div>
- </Shell>
- );
-}
-
-type Playground = {
- href: string;
- label: string;
- description: string;
- icon: LucideIcon;
- variant?: "default" | "primary";
-};
-
-const playgrounds: Playground[] = [
+const playgrounds: CardProps[] = [
{
href: "/play/checker",
- label: "Speed Checker",
+ title: "Speed Checker",
description:
"Get speed insights for your api, website from multiple regions. No account needed.",
icon: Gauge,
@@ -115,28 +55,28 @@ const playgrounds: Playground[] = [
},
{
href: "/play/status",
- label: "Status Page",
+ title: "Status Page",
description:
"Get a status page for your website or api, supporting timezones.",
icon: PanelTop,
},
{
href: "https://astro.openstat.us",
- label: "Custom Astro Status Page",
+ title: "Custom Astro Status Page",
description:
"Grab your API key and create a custom status page with our Astro starter.",
icon: Palette,
},
{
href: "https://time.openstatus.dev",
- label: "Shadcn UI Time Picker",
+ title: "Shadcn UI Time Picker",
description:
"The missing time picker for your next project. Supports 12 hour and 24 hour formats. Fully accessible.",
icon: Clock,
},
{
href: "https://openstat.us",
- label: "All Status Codes",
+ title: "All Status Codes",
description:
"Use the endpoint to return the desired error code for testing purposes.",
icon: FileCode,
diff --git a/apps/web/src/components/play/card.tsx b/apps/web/src/components/play/card.tsx
index 325994929..9169e3cd8 100644
--- a/apps/web/src/components/play/card.tsx
+++ b/apps/web/src/components/play/card.tsx
@@ -6,7 +6,7 @@ import { Button } from "@openstatus/ui";
import { Shell } from "@/components/dashboard/shell";
import { cn } from "@/lib/utils";
-interface CardProps extends React.HTMLAttributes<HTMLDivElement> {
+export interface CardProps extends React.HTMLAttributes<HTMLDivElement> {
href: string;
title: string;
description: string;
@@ -14,9 +14,7 @@ interface CardProps extends React.HTMLAttributes<HTMLDivElement> {
variant?: "default" | "primary";
}
-// TODO: unify the cards of playground, oss-friends and external monitors
-
-function Card({
+export function Card({
title,
description,
href,
@@ -34,10 +32,12 @@ function Card({
? { target: "_blank", rel: "noreferrer" }
: {};
+ const Icon = icon;
+
return (
<Shell
className={cn(
- "group flex flex-col gap-3 hover:shadow",
+ "hover:dark:border-card-foreground/30 group flex flex-col gap-3 hover:shadow",
shellClassName,
className,
)}
@@ -54,7 +54,7 @@ function Card({
</Link>
</Button>
<div className="border-border bg-background rounded-full border p-2 transition-transform duration-200 group-hover:-rotate-12">
- {icon ? icon({ className: "text-muted-foreground h-5 w-5" }) : null}
+ {Icon && <Icon className="text-muted-foreground h-5 w-5" />}
</div>
</div>
</Shell>
diff --git a/apps/web/src/content/faq/about-us.mdx b/apps/web/src/content/faq/about-us.mdx
index 76df9c58d..48756d4e5 100644
--- a/apps/web/src/content/faq/about-us.mdx
+++ b/apps/web/src/content/faq/about-us.mdx
@@ -3,7 +3,7 @@ title: Who are we?
order: 2
---
-{/* TODO: write markdown */}
+We are [Thibault](https://twitter.com/thibaultleouay) and
+[Max](https://twitter.com/mxkaske).
-We are <a href='https://twitter.com/thibaultleouay' target='_blank'>Thibault</a>
-and <a href='https://twitter.com/mxkaske' target='_blank'>Max</a>.
+> An about us page is coming soon where we will share our values and history.
diff --git a/apps/web/src/content/faq/functioning.mdx b/apps/web/src/content/faq/functioning.mdx
index 893787793..370621203 100644
--- a/apps/web/src/content/faq/functioning.mdx
+++ b/apps/web/src/content/faq/functioning.mdx
@@ -3,5 +3,8 @@ title: How does it work?
order: 3
---
-We ping your endpoints from multiple regions to calculate uptime. We display the
-status on your status page.
+We ping your endpoints from multiple regions to calculate uptime and display the
+current status on your status page. We also collect response time data like
+`headers` and `timing` phases and display it on your dashboard.
+
+Try out the [Speed Checker](/play/checker).
diff --git a/apps/web/src/content/faq/help.mdx b/apps/web/src/content/faq/help.mdx
index 22abc480f..0e04e6606 100644
--- a/apps/web/src/content/faq/help.mdx
+++ b/apps/web/src/content/faq/help.mdx
@@ -3,8 +3,14 @@ title: How can I help?
order: 5
---
-{/* TODO: write markdown */}
+There are many ways you can help us:
-You can star our project on
-<a href="https://github.com/openstatusHQ/openstatus">GitHub</a>, or contribute
-to it. Or you can also become a <strong>Pro</strong> user.
+- **Spread the word**: Tell your friends and colleagues about OpenStatus. The
+ more people use it, the more we can improve it.
+- **Report bugs**: If you find a bug, please report it.
+- **Suggest features**: If you have an idea for a new feature, please let us
+ know.
+- **Contribute**: If you are a developer, you can contribute to the project.
+- **Become a paid user**: If you are a business, you can become a paid user.
+- **Star our project**: If you like our project, you can star it on
+ [GitHub](https://github.com/openstatusHQ/openstatus).
diff --git a/apps/web/src/content/faq/limits.mdx b/apps/web/src/content/faq/limits.mdx
index 872014b90..82ffed8a2 100644
--- a/apps/web/src/content/faq/limits.mdx
+++ b/apps/web/src/content/faq/limits.mdx
@@ -3,9 +3,8 @@ title: What are the limits?
order: 1
---
-{/* TODO: write markdown */}
+As free user you will start with a total of **3 monitors** and **1 status page**
+as well as cron jobs of min. `10m`. You can upgrade to a paid plan at any time.
+Check the pricing table for more details.
-You will start with a free plan by default which includes a total of <strong>3
-monitors</strong> and <strong>1 status</strong> page as well as cron jobs of
-either <code>10m</code>, <code>30m</code> or <code>1h</code>.<br />Learn more
-about our <a href='/pricing'>pricing</a>.
+**No credit card** is required to sign up and you can cancel at any time.
diff --git a/apps/web/src/content/faq/supported-regions.mdx b/apps/web/src/content/faq/supported-regions.mdx
index 684421ad9..b014078af 100644
--- a/apps/web/src/content/faq/supported-regions.mdx
+++ b/apps/web/src/content/faq/supported-regions.mdx
@@ -3,4 +3,14 @@ title: What regions do we support?
order: 4
---
-We support one region for each continent to allow multi-regions monitoring.
+We support one region for each continent to allow multi-regions monitoring:
+
+- America: `iad` (Virginia)
+- Europe: `ams` (Amsterdam)
+- Asia: `hkg` (Hong-Kong)
+- Oceania: `syd` (Sydney)
+- Africa: `jnb` (Johannesburg)
+- South America: `gru` (Sao Paulo)
+
+Feel free to [contact us](mailto:[email protected]) if you need a specific
+region.