Skip to content

Open-source status page, incident response and uptime monitoring

refactor: report templates to guides (#1811)

Maximilian Kaske8ea946d1ddad
diff --git a/apps/web/src/app/(landing)/report-template/[slug]/page.tsx b/apps/web/src/app/(landing)/guides/[slug]/page.tsx
similarity index 85%
rename from apps/web/src/app/(landing)/report-template/[slug]/page.tsx
rename to apps/web/src/app/(landing)/guides/[slug]/page.tsx
index 472ef9a03..6934ad1f0 100644
--- a/apps/web/src/app/(landing)/report-template/[slug]/page.tsx
+++ b/apps/web/src/app/(landing)/guides/[slug]/page.tsx
@@ -5,7 +5,7 @@ import {
getPageMetadata,
} from "@/app/shared-metadata";
import { CustomMDX } from "@/content/mdx";
-import { formatDate, getReportTemplates } from "@/content/utils";
+import { formatDate, getGuides } from "@/content/utils";
import { getAuthor } from "@/data/author";
import type { Metadata } from "next";
import Image from "next/image";
@@ -16,7 +16,7 @@ import { ContentPagination } from "../../content-pagination";
export const dynamicParams = false;
export async function generateStaticParams() {
- const posts = getReportTemplates();
+ const posts = getGuides();
return posts.map((post) => ({
slug: post.slug,
@@ -29,23 +29,23 @@ export async function generateMetadata({
params: Promise<{ slug: string }>;
}): Promise<Metadata | undefined> {
const { slug } = await params;
- const post = getReportTemplates().find((post) => post.slug === slug);
+ const post = getGuides().find((post) => post.slug === slug);
if (!post) {
return;
}
- const metadata = getPageMetadata(post, "report-template");
+ const metadata = getPageMetadata(post, "guides");
return metadata;
}
-export default async function ReportTemplate({
+export default async function Guide({
params,
}: {
params: Promise<{ slug: string }>;
}) {
const { slug } = await params;
- const posts = getReportTemplates().sort(
+ const posts = getGuides().sort(
(a, b) =>
b.metadata.publishedAt.getTime() - a.metadata.publishedAt.getTime(),
);
@@ -60,14 +60,14 @@ export default async function ReportTemplate({
const jsonLDBlog: WithContext<BlogPosting> = getJsonLDBlogPosting(
post,
- "report-template",
+ "guides",
);
const jsonLDBreadcrumb: WithContext<BreadcrumbList> = getJsonLDBreadcrumbList(
[
{ name: "Home", url: BASE_URL },
- { name: "Report Templates", url: `${BASE_URL}/report-template` },
- { name: post.metadata.title, url: `${BASE_URL}/report-template/${slug}` },
+ { name: "Guides", url: `${BASE_URL}/guides` },
+ { name: post.metadata.title, url: `${BASE_URL}/guides/${slug}` },
],
);
@@ -108,7 +108,7 @@ export default async function ReportTemplate({
<ContentPagination
previousPost={previousPost}
nextPost={nextPost}
- prefix="/report-template"
+ prefix="/guides"
/>
</section>
);
diff --git a/apps/web/src/app/(landing)/report-template/category/[slug]/page.tsx b/apps/web/src/app/(landing)/guides/category/[slug]/page.tsx
similarity index 65%
rename from apps/web/src/app/(landing)/report-template/category/[slug]/page.tsx
rename to apps/web/src/app/(landing)/guides/category/[slug]/page.tsx
index 768bb16e2..f9e336a45 100644
--- a/apps/web/src/app/(landing)/report-template/category/[slug]/page.tsx
+++ b/apps/web/src/app/(landing)/guides/category/[slug]/page.tsx
@@ -5,11 +5,11 @@ import {
ogMetadata,
twitterMetadata,
} from "@/app/shared-metadata";
-import { getReportTemplates } from "@/content/utils";
+import { getGuides } from "@/content/utils";
import type { Metadata } from "next";
-const TITLE = "Report Template Category";
-const DESCRIPTION = "All the latest templates from openstatus.";
+const TITLE = "Guide Category";
+const DESCRIPTION = "All the latest guides from openstatus.";
export const metadata: Metadata = {
...defaultMetadata,
@@ -31,7 +31,7 @@ export const metadata: Metadata = {
export const dynamicParams = false;
export async function generateStaticParams() {
- const posts = getReportTemplates();
+ const posts = getGuides();
const categories = [...new Set(posts.map((post) => post.metadata.category))];
return categories.map((category) => ({
@@ -39,22 +39,22 @@ export async function generateStaticParams() {
}));
}
-export default async function ReportTemplateCategoryPage({
+export default async function GuideCategoryPage({
params,
}: {
params: Promise<{ slug: string }>;
}) {
const { slug } = await params;
- const allReportTemplates = getReportTemplates();
- const filteredReportTemplates = allReportTemplates.filter(
+ const allGuides = getGuides();
+ const filteredGuides = allGuides.filter(
(post) => post.metadata.category.toLowerCase() === slug.toLowerCase(),
);
return (
<div className="prose dark:prose-invert max-w-none">
- <h1 className="capitalize">Report Template | {slug}</h1>
- <ContentCategory data={allReportTemplates} prefix="/report-template" />
- <ContentList data={filteredReportTemplates} prefix="/report-template" />
+ <h1 className="capitalize">Guides | {slug}</h1>
+ <ContentCategory data={allGuides} prefix="/guides" />
+ <ContentList data={filteredGuides} prefix="/guides" />
</div>
);
}
diff --git a/apps/web/src/app/(landing)/report-template/page.tsx b/apps/web/src/app/(landing)/guides/page.tsx
similarity index 59%
rename from apps/web/src/app/(landing)/report-template/page.tsx
rename to apps/web/src/app/(landing)/guides/page.tsx
index 08701c169..7ebfff73f 100644
--- a/apps/web/src/app/(landing)/report-template/page.tsx
+++ b/apps/web/src/app/(landing)/guides/page.tsx
@@ -1,12 +1,12 @@
import { defaultMetadata, ogMetadata } from "@/app/shared-metadata";
import { twitterMetadata } from "@/app/shared-metadata";
-import { getReportTemplates } from "@/content/utils";
+import { getGuides } from "@/content/utils";
import type { Metadata } from "next";
import { ContentCategory } from "../content-category";
import { ContentList } from "../content-list";
-const TITLE = "Report Template";
-const DESCRIPTION = "All the latest templates from openstatus.";
+const TITLE = "Guides";
+const DESCRIPTION = "All the latest guides from openstatus.";
export const metadata: Metadata = {
...defaultMetadata,
@@ -25,17 +25,13 @@ export const metadata: Metadata = {
},
};
-export default function ReportTemplateListPage() {
- const allReportTemplates = getReportTemplates();
+export default function GuidesListPage() {
+ const allGuides = getGuides();
return (
<div className="prose dark:prose-invert max-w-none">
- <h1>Report Templates</h1>
- <ContentCategory data={allReportTemplates} prefix="/report-template" />
- <ContentList
- data={allReportTemplates}
- prefix="/report-template"
- withCategory
- />
+ <h1>Guides</h1>
+ <ContentCategory data={allGuides} prefix="/guides" />
+ <ContentList data={allGuides} prefix="/guides" withCategory />
</div>
);
}
diff --git a/apps/web/src/app/api/search/route.ts b/apps/web/src/app/api/search/route.ts
index a5a6c7da9..bee440296 100644
--- a/apps/web/src/app/api/search/route.ts
+++ b/apps/web/src/app/api/search/route.ts
@@ -70,6 +70,7 @@ function search(params: SearchParams) {
...getPages("tools").filter((tool) => tool.slug !== "checker-slug"),
...getPages("compare"),
...getPages("product"),
+ ...getPages("guides"),
home,
];
} else {
diff --git a/apps/web/src/app/sitemap.ts b/apps/web/src/app/sitemap.ts
index 9d9b868ea..8694a7288 100644
--- a/apps/web/src/app/sitemap.ts
+++ b/apps/web/src/app/sitemap.ts
@@ -2,9 +2,9 @@ import {
getBlogPosts,
getChangelogPosts,
getComparePages,
+ getGuides,
getHomePage,
getProductPages,
- getReportTemplates,
getToolsPages,
getUnrelatedPages,
} from "@/content/utils";
@@ -20,7 +20,7 @@ const allProducts = getProductPages();
const allPlaygrounds = getToolsPages().filter(
(tool) => tool.slug !== "checker-slug",
);
-const allReportTemplates = getReportTemplates();
+const allGuides = getGuides();
export default function sitemap(): MetadataRoute.Sitemap {
const blogs = allPosts.map((post) => ({
@@ -65,9 +65,9 @@ export default function sitemap(): MetadataRoute.Sitemap {
priority: 0.6,
}));
- const reportTemplates = allReportTemplates.map((reportTemplate) => ({
- url: `https://www.openstatus.dev/report-template/${reportTemplate.slug}`,
- lastModified: reportTemplate.metadata.publishedAt,
+ const guides = allGuides.map((guide) => ({
+ url: `https://www.openstatus.dev/guides/${guide.slug}`,
+ lastModified: guide.metadata.publishedAt,
changeFrequency: "monthly" as const,
priority: 0.6,
}));
@@ -89,6 +89,6 @@ export default function sitemap(): MetadataRoute.Sitemap {
...landings,
...products,
...playgrounds,
- ...reportTemplates,
+ ...guides,
];
}
diff --git a/apps/web/src/content/cmdk.tsx b/apps/web/src/content/cmdk.tsx
index e9d08eb14..b9bce23f9 100644
--- a/apps/web/src/content/cmdk.tsx
+++ b/apps/web/src/content/cmdk.tsx
@@ -106,6 +106,12 @@ const CONFIG: ConfigSection[] = [
heading: "Compare",
page: "compare",
},
+ {
+ type: "group",
+ label: "Search in Guides...",
+ heading: "Guides",
+ page: "guides",
+ },
{
type: "item",
label: "Go to About",
diff --git a/apps/web/src/content/pages/report-template/api-service-disruption.mdx b/apps/web/src/content/pages/guides/api-service-disruption.mdx
similarity index 98%
rename from apps/web/src/content/pages/report-template/api-service-disruption.mdx
rename to apps/web/src/content/pages/guides/api-service-disruption.mdx
index 83dff4314..363434523 100644
--- a/apps/web/src/content/pages/report-template/api-service-disruption.mdx
+++ b/apps/web/src/content/pages/guides/api-service-disruption.mdx
@@ -1,9 +1,9 @@
---
title: "API Service Disruption Template"
description: "Professional template for communicating API outages and third-party service failures to your users."
-author: "OpenStatus"
+author: "openstatus"
publishedAt: "2026-01-19"
-category: "infrastructure"
+category: "template"
---
Use this template when your API or third-party service provider is experiencing issues. Based on real-world examples from companies like Vercel, Stripe, and GitHub.
diff --git a/apps/web/src/content/pages/report-template/database-performance-degradation.mdx b/apps/web/src/content/pages/guides/database-performance-degradation.mdx
similarity index 98%
rename from apps/web/src/content/pages/report-template/database-performance-degradation.mdx
rename to apps/web/src/content/pages/guides/database-performance-degradation.mdx
index e7678eeb9..fbe4166a6 100644
--- a/apps/web/src/content/pages/report-template/database-performance-degradation.mdx
+++ b/apps/web/src/content/pages/guides/database-performance-degradation.mdx
@@ -1,9 +1,9 @@
---
title: "Database Performance Degradation Template"
description: "Technical template for communicating database latency and performance issues to your engineering-focused audience."
-author: "OpenStatus"
+author: "openstatus"
publishedAt: "2026-01-19"
-category: "performance"
+category: "template"
---
Use this template when experiencing database performance issues, elevated latency, or query slowdowns. Ideal for engineering teams and technical stakeholders.
diff --git a/apps/web/src/content/pages/report-template/deployment-rollback.mdx b/apps/web/src/content/pages/guides/deployment-rollback.mdx
similarity index 98%
rename from apps/web/src/content/pages/report-template/deployment-rollback.mdx
rename to apps/web/src/content/pages/guides/deployment-rollback.mdx
index 1ebd8bc56..415f1eef1 100644
--- a/apps/web/src/content/pages/report-template/deployment-rollback.mdx
+++ b/apps/web/src/content/pages/guides/deployment-rollback.mdx
@@ -1,9 +1,9 @@
---
title: "Deployment Rollback Template"
description: "Template for communicating deployment failures and rollback procedures during service disruptions."
-author: "OpenStatus"
+author: "openstatus"
publishedAt: "2026-01-19"
-category: "deployment"
+category: "template"
---
Use this template when a deployment causes issues and requires rolling back to a previous version. Communicates the issue, mitigation, and resolution clearly.
diff --git a/apps/web/src/content/pages/report-template/feature-degradation.mdx b/apps/web/src/content/pages/guides/feature-degradation.mdx
similarity index 99%
rename from apps/web/src/content/pages/report-template/feature-degradation.mdx
rename to apps/web/src/content/pages/guides/feature-degradation.mdx
index 01c9a9f0a..f7af13fdd 100644
--- a/apps/web/src/content/pages/report-template/feature-degradation.mdx
+++ b/apps/web/src/content/pages/guides/feature-degradation.mdx
@@ -1,9 +1,9 @@
---
title: "Feature Degradation Template"
description: "Template for communicating partial service degradation where some features are impacted but the service remains available."
-author: "OpenStatus"
+author: "openstatus"
publishedAt: "2026-01-19"
-category: "performance"
+category: "template"
---
Use this template when specific features are degraded or unavailable, but the core service remains operational. Helps users understand what's working and what isn't.
diff --git a/apps/web/src/content/pages/report-template/network-connectivity-issues.mdx b/apps/web/src/content/pages/guides/network-connectivity-issues.mdx
similarity index 99%
rename from apps/web/src/content/pages/report-template/network-connectivity-issues.mdx
rename to apps/web/src/content/pages/guides/network-connectivity-issues.mdx
index 768cdb315..0c7354ddd 100644
--- a/apps/web/src/content/pages/report-template/network-connectivity-issues.mdx
+++ b/apps/web/src/content/pages/guides/network-connectivity-issues.mdx
@@ -1,9 +1,9 @@
---
title: "Network Connectivity Issues Template"
description: "Template for communicating network outages, CDN problems, and regional connectivity issues to affected users."
-author: "OpenStatus"
+author: "openstatus"
publishedAt: "2026-01-19"
-category: "infrastructure"
+category: "template"
---
Use this template when experiencing network-related issues affecting user connectivity, including CDN problems, regional outages, or ISP issues.
diff --git a/apps/web/src/content/pages/report-template/scheduled-maintenance.mdx b/apps/web/src/content/pages/guides/scheduled-maintenance.mdx
similarity index 99%
rename from apps/web/src/content/pages/report-template/scheduled-maintenance.mdx
rename to apps/web/src/content/pages/guides/scheduled-maintenance.mdx
index 18028cd03..3f049fb81 100644
--- a/apps/web/src/content/pages/report-template/scheduled-maintenance.mdx
+++ b/apps/web/src/content/pages/guides/scheduled-maintenance.mdx
@@ -1,9 +1,9 @@
---
title: "Scheduled Maintenance Template"
description: "Proactive template for communicating planned maintenance windows, upgrades, and scheduled downtime to users."
-author: "OpenStatus"
+author: "openstatus"
publishedAt: "2026-01-19"
-category: "maintenance"
+category: "template"
---
Use this template for planned maintenance, infrastructure upgrades, or scheduled downtime. Proactive communication builds trust and reduces support burden.
diff --git a/apps/web/src/content/pages/report-template/security-incident-response.mdx b/apps/web/src/content/pages/guides/security-incident-response.mdx
similarity index 99%
rename from apps/web/src/content/pages/report-template/security-incident-response.mdx
rename to apps/web/src/content/pages/guides/security-incident-response.mdx
index 763b444ab..caf5f8da4 100644
--- a/apps/web/src/content/pages/report-template/security-incident-response.mdx
+++ b/apps/web/src/content/pages/guides/security-incident-response.mdx
@@ -1,9 +1,9 @@
---
title: "Security Incident Response Template"
description: "Formal template for communicating security issues with professional, reassuring language that maintains user trust."
-author: "OpenStatus"
+author: "openstatus"
publishedAt: "2026-01-19"
-category: "security"
+category: "template"
---
Use this template when investigating or responding to security-related incidents. Maintains professional tone while reassuring users about security measures.
diff --git a/apps/web/src/content/pages/blog/top-five-atlassian-statuspage-alternatives.mdx b/apps/web/src/content/pages/guides/top-five-atlassian-statuspage-alternatives.mdx
similarity index 99%
rename from apps/web/src/content/pages/blog/top-five-atlassian-statuspage-alternatives.mdx
rename to apps/web/src/content/pages/guides/top-five-atlassian-statuspage-alternatives.mdx
index f756ca25b..0868e0b3c 100644
--- a/apps/web/src/content/pages/blog/top-five-atlassian-statuspage-alternatives.mdx
+++ b/apps/web/src/content/pages/guides/top-five-atlassian-statuspage-alternatives.mdx
@@ -4,7 +4,7 @@ image: "/assets/posts/top-five-atlassian-statuspage-alternatives/hero.png"
description: "Explore the best alternatives to Atlassian Statuspage including OpenStatus, Status-io, Datadog Status Page, Instatus, and Betterstack."
author: "Thibault Le Ouay Ducasse"
publishedAt: "2025-11-05"
-category: "guide"
+category: "alternative"
---
Atlassian Statuspage has long been a go-to choice for organizations needing to communicate their service status. It's a robust, mature platform. However, the service reliability and incident communication landscape is evolving rapidly.
diff --git a/apps/web/src/content/utils.ts b/apps/web/src/content/utils.ts
index 585e10936..8cc2e63c8 100644
--- a/apps/web/src/content/utils.ts
+++ b/apps/web/src/content/utils.ts
@@ -91,10 +91,10 @@ export function getProductPages(): MDXData[] {
);
}
-export function getReportTemplates(): MDXData[] {
+export function getGuides(): MDXData[] {
return getMDXDataFromDir(
- path.join(process.cwd(), "src", "content", "pages", "report-template"),
- "/report-template",
+ path.join(process.cwd(), "src", "content", "pages", "guides"),
+ "/guides",
);
}
@@ -158,6 +158,7 @@ export const PAGE_TYPES = [
"unrelated",
"compare",
"tools",
+ "guides",
"all",
] as const;
@@ -177,6 +178,8 @@ export function getPages(type: PageType) {
return getComparePages();
case "tools":
return getToolsPages();
+ case "guides":
+ return getGuides();
case "all":
return [
...getBlogPosts(),
@@ -185,6 +188,7 @@ export function getPages(type: PageType) {
...getUnrelatedPages(),
...getComparePages(),
...getToolsPages(),
+ ...getGuides(),
];
default:
throw new Error(`Unknown page type: ${type}`);
diff --git a/apps/web/src/data/content.ts b/apps/web/src/data/content.ts
index bb305aa52..9a0f35d9a 100644
--- a/apps/web/src/data/content.ts
+++ b/apps/web/src/data/content.ts
@@ -31,8 +31,8 @@ const resourcesFooterSection = {
href: "https://docs.openstatus.dev",
},
{
- label: "Report Templates",
- href: "/report-template",
+ label: "Guides",
+ href: "/guides",
},
{
label: "External Status",