Merge branch 'master' into fix-header-onbarding-overlap

Author: a-hariti

.github/ISSUE_TEMPLATE/issue-content-03-develop.yml

@@ -0,0 +1,38 @@
+name: "📝 Documentation on develop.sentry.dev"
+labels: ["Type: Content", "Develop"]
+description: Missing, incorrect, or unclear developer documentation.
+body:
+  - type: markdown
+    attributes:
+      value: |-
+        Is the documentation issue something you know how to fix? Consider contributing to Open Source by opening a PR to fix it instead!
+  - type: input
+    id: area-specific
+    attributes:
+      label: Which section?
+      description: Which section of the developer documentation needs to be updated?
+    validations:
+      required: true
+  - type: input
+    id: page-url
+    attributes:
+      label: Page URL
+      description: Please provide the URL of the page which should be changed (if applicable).
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: What were you looking for/trying to do/expecting?
+    validations:
+      required: true
+  - type: textarea
+    id: solution
+    attributes:
+      label: Suggested Solution
+      description: If you have an idea on how we can solve this, please share.
+  - type: markdown
+    attributes:
+      value: |-
+        ## Thanks 🙏
+        Check our [triage docs](https://open.sentry.io/triage/) for what to expect next.
+  

app/[[...path]]/page.tsx

@@ -11,8 +11,11 @@ import {Home} from 'sentry-docs/components/home';
 import {Include} from 'sentry-docs/components/include';
 import {PlatformContent} from 'sentry-docs/components/platformContent';
 import {
+  DocNode,
   getCurrentPlatformOrGuide,
   getDocsRootNode,
+  getNextNode,
+  getPreviousNode,
   nodeForPath,
 } from 'sentry-docs/docTree';
 import {isDeveloperDocs} from 'sentry-docs/isDeveloperDocs';
@@ -24,6 +27,7 @@ import {
 } from 'sentry-docs/mdx';
 import {mdxComponents} from 'sentry-docs/mdxComponents';
 import {setServerContext} from 'sentry-docs/serverContext';
+import {PaginationNavNode} from 'sentry-docs/types/paginationNavNode';
 import {stripVersion} from 'sentry-docs/versioning';
 
 export async function generateStaticParams() {
@@ -42,7 +46,11 @@ export const dynamic = 'force-static';
 
 const mdxComponentsWithWrapper = mdxComponents(
   {Include, PlatformContent},
-  ({children, frontMatter}) => <DocPage frontMatter={frontMatter}>{children}</DocPage>
+  ({children, frontMatter, nextPage, previousPage}) => (
+    <DocPage frontMatter={frontMatter} nextPage={nextPage} previousPage={previousPage}>
+      {children}
+    </DocPage>
+  )
 );
 
 function MDXLayoutRenderer({mdxSource, ...rest}) {
@@ -59,6 +67,42 @@ export default async function Page({params}: {params: {path?: string[]}}) {
     path: params.path ?? [],
   });
 
+  if (!params.path && !isDeveloperDocs) {
+    return <Home />;
+  }
+
+  const pageNode = nodeForPath(rootNode, params.path ?? '');
+
+  if (!pageNode) {
+    // eslint-disable-next-line no-console
+    console.warn('no page node', params.path);
+    return notFound();
+  }
+
+  // gather previous and next page that will be displayed in the bottom pagination
+  const getPaginationDetails = (
+    getNode: (node: DocNode) => DocNode | undefined | 'root',
+    page: PaginationNavNode | undefined
+  ) => {
+    if (page && 'path' in page && 'title' in page) {
+      return page;
+    }
+
+    const node = getNode(pageNode);
+
+    if (node === 'root') {
+      return {path: '', title: 'Welcome to Sentry'};
+    }
+
+    return node ? {path: node.path, title: node.frontmatter.title} : undefined;
+  };
+
+  const previousPage = getPaginationDetails(
+    getPreviousNode,
+    pageNode?.frontmatter?.previousPage
+  );
+  const nextPage = getPaginationDetails(getNextNode, pageNode?.frontmatter?.nextPage);
+
   if (isDeveloperDocs) {
     // get the MDX for the current doc and render it
     let doc: Awaited<ReturnType<typeof getFileBySlug>> | null = null;
@@ -74,13 +118,17 @@ export default async function Page({params}: {params: {path?: string[]}}) {
     }
     const {mdxSource, frontMatter} = doc;
     // pass frontmatter tree into sidebar, rendered page + fm into middle, headers into toc
-    return <MDXLayoutRenderer mdxSource={mdxSource} frontMatter={frontMatter} />;
-  }
-  if (!params.path) {
-    return <Home />;
+    return (
+      <MDXLayoutRenderer
+        mdxSource={mdxSource}
+        frontMatter={frontMatter}
+        nextPage={nextPage}
+        previousPage={previousPage}
+      />
+    );
   }
 
-  if (params.path[0] === 'api' && params.path.length > 1) {
+  if (params.path?.[0] === 'api' && params.path.length > 1) {
     const categories = await apiCategories();
     const category = categories.find(c => c.slug === params?.path?.[1]);
     if (category) {
@@ -94,14 +142,6 @@ export default async function Page({params}: {params: {path?: string[]}}) {
     }
   }
 
-  const pageNode = nodeForPath(rootNode, params.path);
-
-  if (!pageNode) {
-    // eslint-disable-next-line no-console
-    console.warn('no page node', params.path);
-    return notFound();
-  }
-
   // get the MDX for the current doc and render it
   let doc: Awaited<ReturnType<typeof getFileBySlug>> | null = null;
   try {
@@ -122,7 +162,12 @@ export default async function Page({params}: {params: {path?: string[]}}) {
 
   // pass frontmatter tree into sidebar, rendered page + fm into middle, headers into toc.
   return (
-    <MDXLayoutRenderer mdxSource={mdxSource} frontMatter={{...frontMatter, versions}} />
+    <MDXLayoutRenderer
+      mdxSource={mdxSource}
+      frontMatter={{...frontMatter, versions}}
+      nextPage={nextPage}
+      previousPage={previousPage}
+    />
   );
 }
 
@@ -132,6 +177,17 @@ type MetadataProps = {
   };
 };
 
+// Helper function to clean up canonical tags missing leading or trailing slash
+function formatCanonicalTag(tag: string) {
+  if (tag.charAt(0) !== '/') {
+    tag = '/' + tag;
+  }
+  if (tag.charAt(tag.length - 1) !== '/') {
+    tag = tag + '/';
+  }
+  return tag;
+}
+
 export async function generateMetadata({params}: MetadataProps): Promise<Metadata> {
   const domain = isDeveloperDocs
     ? 'https://develop.sentry.dev'
@@ -142,6 +198,7 @@ export async function generateMetadata({params}: MetadataProps): Promise<Metadat
     : domain;
   let title =
     'Sentry Docs | Application Performance Monitoring &amp; Error Tracking Software';
+  let customCanonicalTag;
   let description =
     'Self-hosted and cloud-based application performance monitoring &amp; error tracking that helps software teams see clearer, solve quicker, &amp; learn continuously.';
   const images = [{url: `${previewDomain ?? domain}/meta.jpg`, width: 1200, height: 822}];
@@ -160,13 +217,18 @@ export async function generateMetadata({params}: MetadataProps): Promise<Metadat
         pageNode.frontmatter.title +
         (guideOrPlatform ? ` | Sentry for ${guideOrPlatform.title}` : '');
       description = pageNode.frontmatter.description ?? '';
+
+      if (pageNode.frontmatter.customCanonicalTag) {
+        customCanonicalTag = formatCanonicalTag(pageNode.frontmatter.customCanonicalTag);
+      }
     }
   }
 
-  let canonical = domain;
-  if (params.path) {
-    canonical = `${domain}/${params.path.join('/')}/`;
-  }
+  const canonical = customCanonicalTag
+    ? domain + customCanonicalTag
+    : params.path
+      ? `${domain}/${params.path.join('/')}/`
+      : domain;
 
   return {
     title,

app/platform-redirect/page.tsx

@@ -1,5 +1,6 @@
 import {redirect} from 'next/navigation';
 
+import {Alert} from 'sentry-docs/components/alert';
 import {DocPage} from 'sentry-docs/components/docPage';
 import {PlatformIcon} from 'sentry-docs/components/platformIcon';
 import {SmartLink} from 'sentry-docs/components/smartLink';
@@ -14,16 +15,31 @@ export default async function Page({
   if (Array.isArray(next)) {
     next = next[0];
   }
+
   // discard the hash
   const [pathname, _] = next.split('#');
   const rootNode = await getDocsRootNode();
+  const defaultTitle = 'Platform Specific Content';
+  let description = '';
+  const platformInfo =
+    "The page you are looking for is customized for each platform. Select your platform below and we'll direct you to the most specific documentation on it.";
+  let title = defaultTitle;
+
   // get rid of irrelevant platforms for the `next` path
   const platformList = extractPlatforms(rootNode).filter(platform_ => {
-    return !!nodeForPath(rootNode, [
+    const node = nodeForPath(rootNode, [
       'platforms',
       platform_.key,
       ...pathname.split('/').filter(Boolean),
     ]);
+
+    // extract title and description for displaying it on page
+    if (node && title === defaultTitle && pathname.length > 0) {
+      title = node.frontmatter.title ?? title;
+      description = node.frontmatter.description || '';
+    }
+
+    return !!node;
   });
 
   if (platformList.length === 0) {
@@ -42,18 +58,16 @@ export default async function Page({
   }
 
   const frontMatter = {
-    title: 'Platform Specific Content',
+    title,
+    description,
   };
 
   // make the Sidebar aware of the current path
   setServerContext({rootNode, path: ['platform-redirect']});
 
   return (
     <DocPage frontMatter={frontMatter}>
-      <p>
-        The page you are looking for is customized for each platform. Select your platform
-        below and we&apos;ll direct you to the most specific documentation on it.
-      </p>
+      <Alert level="info">{platformInfo}</Alert>
 
       <ul>
         {platformList.map(p => (

apps/changelog/package.json

@@ -21,16 +21,16 @@
     "@radix-ui/react-icons": "^1.3.0",
     "@radix-ui/react-toolbar": "^1.0.4",
     "@radix-ui/themes": "^2.0.3",
-    "@sentry/nextjs": "8.29.0",
+    "@sentry/nextjs": "8.36.0-beta.0",
     "@spotlightjs/spotlight": "^2.1.1",
-    "next": "^15.0.0-canary.83",
+    "next": "15.0.0-rc.1",
     "next-auth": "^4.24.5",
     "next-mdx-remote": "^4.4.1",
     "nextjs-toploader": "^1.6.6",
     "nuqs": "^1.17.7",
     "prism-sentry": "^1.0.2",
-    "react": "beta",
-    "react-dom": "beta",
+    "react": "19.0.0-rc-cd22717c-20241013",
+    "react-dom": "19.0.0-rc-cd22717c-20241013",
     "react-select": "^5.7.3",
     "react-textarea-autosize": "^8.5.3",
     "rehype-prism-plus": "^1.6.3",
@@ -44,8 +44,8 @@
     "@tailwindcss/forms": "^0.5.7",
     "@tailwindcss/typography": "^0.5.10",
     "@types/node": "^20",
-    "@types/react": "^18",
-    "@types/react-dom": "^18.3.0",
+    "@types/react": "npm:[email protected]",
+    "@types/react-dom": "npm:[email protected]",
     "@types/rss": "^0.0.32",
     "autoprefixer": "^10.4.17",
     "dotenv-cli": "^7.4.2",
@@ -58,5 +58,9 @@
   },
   "volta": {
     "extends": "../../package.json"
+  },
+  "resolutions": {
+    "@types/react": "npm:[email protected]",
+    "@types/react-dom": "npm:[email protected]"
   }
 }

apps/changelog/src/app/changelog/%5Fadmin/[id]/edit/page.tsx

@@ -4,7 +4,10 @@ import Link from 'next/link';
 import {prismaClient} from '@/server/prisma-client';
 import {EditChangelogForm} from '@/client/components/forms/editChangelogForm';
 
-export default async function ChangelogCreatePage({params}: {params: {id: string}}) {
+export default async function ChangelogCreatePage(props: {
+  params: Promise<{id: string}>;
+}) {
+  const params = await props.params;
   const categories = await prismaClient.category.findMany({
     orderBy: {
       name: 'asc',

apps/changelog/src/app/changelog/[slug]/page.tsx

@@ -16,9 +16,10 @@ import {mdxOptions} from '@/server/mdxOptions';
 export const dynamic = 'force-dynamic';
 
 export async function generateMetadata(
-  {params}: {params: {slug: string}},
+  props: {params: Promise<{slug: string}>},
   parent: ResolvingMetadata
 ): Promise<Metadata> {
+  const params = await props.params;
   let changelog: Changelog | null = null;
   try {
     changelog = await getChangelog(params.slug);
@@ -57,7 +58,8 @@ const getChangelog = unstable_cache(
   {tags: ['changelog-detail']}
 );
 
-export default async function ChangelogEntry({params}: {params: {slug: string}}) {
+export default async function ChangelogEntry(props: {params: Promise<{slug: string}>}) {
+  const params = await props.params;
   const changelog = await getChangelog(params.slug);
 
   if (!changelog) {

develop-docs/application/config.mdx

@@ -1,5 +1,6 @@
 ---
 title: Configuration
+sidebar_order: 60
 ---
 
 This document describes configuration available to the Sentry server itself.

develop-docs/backend/control-silo.mdx develop-docs/application/control-silo.mdxdevelop-docs/backend/control-silo.mdx renamed to develop-docs/application/control-silo.mdx

@@ -1,5 +1,6 @@
 ---
 title: Control Silo
+sidebar_order: 30
 ---
 
 Within the Control Silo are features that allow us to provide backwards compatibility for both customer API usage, and integrations

…ocs/backend/cross-region-replication.mdx …application/cross-region-replication.mdxdevelop-docs/backend/cross-region-replication.mdx renamed to develop-docs/application/cross-region-replication.mdx develop-docs/backend/cross-region-replication.mdx renamed to develop-docs/application/cross-region-replication.mdx

@@ -1,5 +1,6 @@
 ---
 title: Cross Region Replication
+sidebar_order: 40
 ---
 
 Our data-model includes many relations between users and the objects they create or interact with. Eventually users are deleted, and they need to be detached from the records they created, or those records need to be destroyed. Before sentry became a multi-region application, we relied on a mixture of Django callbacks, and postgres constraints to cascade deletions. However, in a multi-region state we arent't able to rely on these anymore as Users are in [Control Silo](/architecture/#silo-modes) and many of the objects they interact with are in the various Region Silos.

develop-docs/backend/cross-region-rpc.mdx …op-docs/application/cross-region-rpc.mdxdevelop-docs/backend/cross-region-rpc.mdx renamed to develop-docs/application/cross-region-rpc.mdx develop-docs/backend/cross-region-rpc.mdx renamed to develop-docs/application/cross-region-rpc.mdx

@@ -1,5 +1,6 @@
 ---
 title: Cross Region RPC
+sidebar_order: 50
 ---
 
 When Sentry is deployed in a multi-region deployment (like sentry.io) there are many scenarios and workflows where a region silo requires information that is stored in Control Silo. Similarly there are flows where Control Silo operations need to read or mutate state stored in regions.