Merge branch 'master' into buenaflor-patch-1

Author: buenaflor

.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.
+  

.github/workflows/enforce-version-convention.yml

@@ -0,0 +1,22 @@
+name: Enforce Version Conventions
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  check-version-convention:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Install bun
+        uses: oven-sh/setup-bun@v2
+        with:
+          bun-version: latest
+
+      - name: Run script for checking conventions
+        run: bun scripts/check-version-conventions.ts

.github/workflows/test.yml

@@ -57,7 +57,6 @@ jobs:
         with:
           github-token: ${{ steps.token.outputs.token }}
 
-  # TODO(mjq): Bring this back once tests are working.
   job_test:
     name: Test
     runs-on: ubuntu-latest
@@ -72,5 +71,4 @@ jobs:
       - run: yarn install --frozen-lockfile
         if: steps.cache.outputs.cache-hit != 'true'
       - name: Run Tests
-        # run: yarn test
-        run: true
+        run: yarn test

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

@@ -16,9 +16,15 @@ import {
   nodeForPath,
 } from 'sentry-docs/docTree';
 import {isDeveloperDocs} from 'sentry-docs/isDeveloperDocs';
-import {getDevDocsFrontMatter, getDocsFrontMatter, getFileBySlug} from 'sentry-docs/mdx';
+import {
+  getDevDocsFrontMatter,
+  getDocsFrontMatter,
+  getFileBySlug,
+  getVersionsFromDoc,
+} from 'sentry-docs/mdx';
 import {mdxComponents} from 'sentry-docs/mdxComponents';
 import {setServerContext} from 'sentry-docs/serverContext';
+import {stripVersion} from 'sentry-docs/versioning';
 
 export async function generateStaticParams() {
   const docs = await (isDeveloperDocs ? getDevDocsFrontMatter() : getDocsFrontMatter());
@@ -47,6 +53,7 @@ function MDXLayoutRenderer({mdxSource, ...rest}) {
 export default async function Page({params}: {params: {path?: string[]}}) {
   // get frontmatter of all docs in tree
   const rootNode = await getDocsRootNode();
+
   setServerContext({
     rootNode,
     path: params.path ?? [],
@@ -88,6 +95,7 @@ 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);
@@ -108,8 +116,14 @@ export default async function Page({params}: {params: {path?: string[]}}) {
   }
   const {mdxSource, frontMatter} = doc;
 
+  // collect versioned files
+  const allFm = await getDocsFrontMatter();
+  const versions = getVersionsFromDoc(allFm, pageNode.path);
+
   // pass frontmatter tree into sidebar, rendered page + fm into middle, headers into toc.
-  return <MDXLayoutRenderer mdxSource={mdxSource} frontMatter={frontMatter} />;
+  return (
+    <MDXLayoutRenderer mdxSource={mdxSource} frontMatter={{...frontMatter, versions}} />
+  );
 }
 
 type MetadataProps = {
@@ -135,9 +149,13 @@ export async function generateMetadata({params}: MetadataProps): Promise<Metadat
   const rootNode = await getDocsRootNode();
 
   if (params.path) {
-    const pageNode = nodeForPath(rootNode, params.path);
+    const pageNode = nodeForPath(
+      rootNode,
+      stripVersion(params.path.join('/')).split('/')
+    );
     if (pageNode) {
       const guideOrPlatform = getCurrentPlatformOrGuide(rootNode, params.path);
+
       title =
         pageNode.frontmatter.title +
         (guideOrPlatform ? ` | Sentry for ${guideOrPlatform.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 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