Skip to content

Open-source status page, incident response and uptime monitoring

fix: docs page metadata (#2270)

Maximilian Kaskebb436e695ad8
diff --git a/apps/web/src/app/(docs)/docs/[[...slug]]/page.tsx b/apps/web/src/app/(docs)/docs/[[...slug]]/page.tsx
index 6c22245fc..fb740ad98 100644
--- a/apps/web/src/app/(docs)/docs/[[...slug]]/page.tsx
+++ b/apps/web/src/app/(docs)/docs/[[...slug]]/page.tsx
@@ -27,7 +27,11 @@ import { CustomMDX } from "@/content/mdx";
import { Grid } from "@/content/mdx-components/grid";
import { extractHeadings } from "@/content/toc";
import { JsonLd } from "@/lib/metadata/json-ld";
-import { BASE_URL } from "@/lib/metadata/shared-metadata";
+import {
+ BASE_URL,
+ getPageMetadata,
+ getSocialMetadata,
+} from "@/lib/metadata/shared-metadata";
import {
createJsonLDGraph,
getJsonLDBreadcrumbList,
@@ -43,8 +47,27 @@ export const dynamicParams = false;
const EDIT_BASE =
"https://github.com/openstatusHQ/openstatus/edit/main/apps/web/src/content/pages/docs";
+const DOCS_DESCRIPTION =
+ "Learn how to create your status page, monitor your endpoints, and configure notifications with openstatus.";
+
type Params = { slug?: string[] };
+// Hub pages (the /docs root and section landings) have no backing MDX file.
+function getHubMetadata(title: string, href: string): Metadata {
+ const url = `${BASE_URL}${href}`;
+ return {
+ title,
+ description: DOCS_DESCRIPTION,
+ alternates: { canonical: url },
+ ...getSocialMetadata({
+ title,
+ description: DOCS_DESCRIPTION,
+ url,
+ category: "docs",
+ }),
+ };
+}
+
export function generateStaticParams(): Params[] {
const { errors, warnings } = validateDocsNav();
for (const w of warnings) console.warn(`[docs] ${w}`);
@@ -67,30 +90,21 @@ export async function generateMetadata({
}): Promise<Metadata | undefined> {
const { slug } = await params;
if (!slug || slug.length === 0) {
- return {
- title: "openstatus documentation",
- description:
- "Learn how to create your status page, monitor your endpoints, and configure notifications with openstatus.",
- alternates: { canonical: `${BASE_URL}/docs` },
- };
+ return getHubMetadata("openstatus documentation", "/docs");
}
const joined = slug.join("/");
const doc = getDocsPage(joined);
if (!doc) {
const node = findDocsNode(docsNavTree(), `/docs/${joined}`);
if (node?.children?.length) {
- return {
- title: `${node.label} — openstatus docs`,
- alternates: { canonical: `${BASE_URL}/docs/${joined}` },
- };
+ return getHubMetadata(
+ `${node.label} — openstatus docs`,
+ `/docs/${joined}`,
+ );
}
return;
}
- return {
- title: doc.metadata.title,
- description: doc.metadata.description,
- alternates: { canonical: `${BASE_URL}${doc.href}` },
- };
+ return getPageMetadata(doc, "docs");
}
// A container node (the /docs hub or a section) → one card per child. Same nav
diff --git a/apps/web/src/lib/metadata/shared-metadata.ts b/apps/web/src/lib/metadata/shared-metadata.ts
index 37f7cd0af..bb3d96a27 100644
--- a/apps/web/src/lib/metadata/shared-metadata.ts
+++ b/apps/web/src/lib/metadata/shared-metadata.ts
@@ -44,29 +44,25 @@ export const defaultMetadata: Metadata = {
openGraph: ogMetadata,
};
-export const getPageMetadata = (page: MDXData, basePath?: string): Metadata => {
- const { slug, metadata } = page;
- const { title, description, category, publishedAt } = metadata;
-
- const ogImage = `${BASE_URL}/api/og?title=${encodeURIComponent(
- title,
- )}&description=${encodeURIComponent(description)}&category=${encodeURIComponent(category)}`;
+// Next merges metadata shallowly per field, so a page must emit its own
+// og/twitter blocks or it inherits the root layout's generic ones wholesale.
+export const getSocialMetadata = (args: {
+ title: string;
+ description: string;
+ url: string;
+ category?: string;
+}): Pick<Metadata, "openGraph" | "twitter"> => {
+ const { title, description, url, category } = args;
- const url = basePath
- ? `${BASE_URL}/${basePath}/${slug}`
- : `${BASE_URL}/${slug}`;
+ const searchParams = new URLSearchParams({ title, description });
+ if (category) searchParams.set("category", category);
+ const ogImage = `${BASE_URL}/api/og?${searchParams.toString()}`;
return {
- title,
- description,
- alternates: {
- canonical: url,
- },
openGraph: {
title,
description,
- type: "article",
- publishedTime: publishedAt.toISOString(),
+ type: "website",
url,
images: [
{
@@ -82,3 +78,33 @@ export const getPageMetadata = (page: MDXData, basePath?: string): Metadata => {
},
};
};
+
+export const getPageMetadata = (page: MDXData, basePath?: string): Metadata => {
+ const { slug, metadata } = page;
+ const { title, description, category, publishedAt } = metadata;
+
+ const url = basePath
+ ? `${BASE_URL}/${basePath}/${slug}`
+ : `${BASE_URL}/${slug}`;
+
+ const { openGraph, twitter } = getSocialMetadata({
+ title,
+ description,
+ url,
+ category,
+ });
+
+ return {
+ title,
+ description,
+ alternates: {
+ canonical: url,
+ },
+ openGraph: {
+ ...openGraph,
+ type: "article",
+ publishedTime: publishedAt.toISOString(),
+ },
+ twitter,
+ };
+};