Merge branch 'master' into next-steps-config

Author: a-hariti

.env.example

@@ -9,3 +9,6 @@ GATSBY_ALGOLIA_INDEX_PREFIX=test-sentry-
 # ALGOLIA_ADMIN_KEY=
 # ALGOLIA_INDEX=0
 # SENTRY_AUTH_TOKEN=
+DATABASE_URL=postgresql://postgres:postgres@localhost:5432/changelog
+NEXTAUTH_URL=http://localhost:3000
+NEXTAUTH_SECRET=secret

.gitignore

@@ -93,3 +93,5 @@ public/page-data
 
 # tsbuildinfo file generated by CI
 tsconfig.tsbuildinfo
+
+public/mdx-images/*

CONTRIBUTING.md

@@ -0,0 +1,43 @@
+<p align="center">
+  <a href="https://sentry.io/?utm_source=github&utm_medium=logo" target="_blank">
+    <img src="https://sentry-brand.storage.googleapis.com/sentry-wordmark-dark-280x84.png" alt="Sentry" width="280" height="84">
+  </a>
+</p>
+
+## Setting up an Environment
+
+We use Next.js, `yarn` and `volta` to manage the environment.
+
+```
+cp .env.example .env.development
+yarn
+yarn dev
+```
+
+With that, the repo is fully set up and you are ready to open local docs under http://localhost:3000
+
+### Database
+
+There is a compose file to start a local postgres db:
+
+```
+docker-compose up -d
+```
+
+If you already run a local postgres, it will create a `changelog` table.
+
+The inital setup or the clean the database call:
+
+```
+yarn migrate:dev
+```
+
+To add new entries, visit `/changelog/_admin` you need to have a Google Account in the Sentry org to login.
+
+#### Seeding
+
+Call
+
+```
+npx prisma db seed
+```

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

@@ -22,11 +22,8 @@ import {capitilize} from 'sentry-docs/utils';
 
 export async function generateStaticParams() {
   const docs = await getDocsFrontMatter();
-  const paths = docs.map(doc => {
-    let path = doc.slug.split('/');
-    if (path[path.length - 1] === 'index') {
-      path = path.slice(0, path.length - 1);
-    }
+  const paths: {path: string[] | undefined}[] = docs.map(doc => {
+    const path = doc.slug.split('/');
     return {path};
   });
   paths.push({path: undefined}); // the home page
@@ -86,7 +83,7 @@ export default async function Page({params}) {
   }
 
   // get the MDX for the current doc and render it
-  let doc: any = null;
+  let doc: Awaited<ReturnType<typeof getFileBySlug>> | null = null;
   try {
     doc = await getFileBySlug(`docs/${pageNode.path}`);
   } catch (e) {
@@ -112,9 +109,15 @@ type MetadataProps = {
 
 export async function generateMetadata({params}: MetadataProps): Promise<Metadata> {
   const domain = 'https://docs.sentry.io';
-  let title = 'Home';
-  let description = '';
-  const images = [{url: `${domain}/meta.png`, width: 1200, height: 630}];
+  // enable og iamge preview on preview deployments
+  const previewDomain = process.env.VERCEL_URL
+    ? `https://${process.env.VERCEL_URL}`
+    : domain;
+  let title =
+    'Sentry Docs | Application Performance Monitoring &amp; Error Tracking Software';
+  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}];
 
   const rootNode = await getDocsRootNode();
 
@@ -125,7 +128,7 @@ export async function generateMetadata({params}: MetadataProps): Promise<Metadat
       title =
         pageNode.frontmatter.title +
         (guideOrPlatform ? ` | Sentry for ${capitilize(guideOrPlatform.name)}` : '');
-      description = pageNode.frontmatter.description;
+      description = pageNode.frontmatter.description ?? '';
     }
   }
 

app/changelog/[slug]/page.tsx

@@ -1,6 +1,5 @@
 import {Fragment, Suspense} from 'react';
 import {type Category, type Changelog} from '@prisma/client';
-import * as Sentry from '@sentry/nextjs';
 import {GET as sessionHandler} from 'app/api/auth/[...nextauth]/route';
 import type {Metadata, ResolvingMetadata} from 'next';
 import {unstable_cache} from 'next/cache';
@@ -37,9 +36,6 @@ export async function generateMetadata(
     openGraph: {
       images: changelog?.image || (await parent).openGraph?.images,
     },
-    other: {
-      'sentry-trace': `${Sentry.getActiveSpan()?.toTraceparent()}`,
-    },
   };
 }
 

app/changelog/feed.xml/route.ts

@@ -0,0 +1,39 @@
+import {getChangelogs} from 'app/changelog/utils';
+import RSS from 'rss';
+
+export async function GET() {
+  const feed = new RSS({
+    title: 'Sentry Changelog',
+    description:
+      'Stay up to date on everything big and small, from product updates to SDK changes with the Sentry Changelog.',
+    feed_url: 'https://sentry.io/changelog/feed.xml',
+    site_url: 'https://sentry.io/changelog',
+    copyright: `Copyright ${new Date().getFullYear().toString()}, Sentry`,
+    language: 'en-US',
+    pubDate: new Date().toUTCString(),
+    ttl: 60,
+  });
+
+  const allChangelogs = await getChangelogs();
+
+  if (allChangelogs) {
+    allChangelogs.map(changelog => {
+      return feed.item({
+        title: changelog.title,
+        description: changelog.summary,
+        url: `https://sentry.io/changelog/${changelog.slug}`,
+        categories:
+          changelog.categories.map(category => {
+            return category.name;
+          }) || [],
+        date: changelog.publishedAt,
+      });
+    });
+  }
+
+  return new Response(feed.xml({indent: true}), {
+    headers: {
+      'Content-Type': 'application/xml; charset=utf-8',
+    },
+  });
+}

app/changelog/layout.tsx

@@ -19,6 +19,9 @@ const rubik = Rubik({
 export const metadata: Metadata = {
   title: {template: '%s | Sentry Changelog', default: 'Changelog'},
   metadataBase: new URL('https://sentry.io/changelog/'),
+  openGraph: {
+    images: 'https://docs.sentry.io/changelog/assets/hero.png',
+  },
 };
 
 export default function ChangelogLayout({children}: {children: ReactNode}) {

app/changelog/page.tsx

@@ -1,33 +1,13 @@
 import {Fragment} from 'react';
-import * as Sentry from '@sentry/nextjs';
 import type {Metadata} from 'next';
-import {unstable_cache} from 'next/cache';
 
 import List from 'sentry-docs/components/changelog/list';
-import prisma from 'sentry-docs/prisma';
 
 import Header from './header';
+import {getChangelogs} from './utils';
 
 export const dynamic = 'force-dynamic';
 
-const getChangelogs = unstable_cache(
-  async () => {
-    return await prisma.changelog.findMany({
-      include: {
-        categories: true,
-      },
-      where: {
-        published: true,
-      },
-      orderBy: {
-        publishedAt: 'desc',
-      },
-    });
-  },
-  ['changelogs'],
-  {tags: ['changelogs']}
-);
-
 export default async function ChangelogList() {
   const changelogs = await getChangelogs();
 
@@ -46,8 +26,5 @@ export function generateMetadata(): Metadata {
     alternates: {
       canonical: `https://sentry.io/changelog/`,
     },
-    other: {
-      'sentry-trace': `${Sentry.getActiveSpan()?.toTraceparent()}`,
-    },
   };
 }

app/changelog/utils.ts

@@ -0,0 +1,21 @@
+import {unstable_cache} from 'next/cache';
+
+import prisma from 'sentry-docs/prisma';
+
+export const getChangelogs = unstable_cache(
+  async () => {
+    return await prisma.changelog.findMany({
+      include: {
+        categories: true,
+      },
+      where: {
+        published: true,
+      },
+      orderBy: {
+        publishedAt: 'desc',
+      },
+    });
+  },
+  ['changelogs'],
+  {tags: ['changelogs']}
+);

app/layout.tsx

@@ -4,7 +4,13 @@ import Script from 'next/script';
 export const metadata: Metadata = {
   title: 'Home',
   icons: {
-    icon: '/favicon.ico',
+    icon: 'https://docs.sentry.io/favicon.ico',
+  },
+  openGraph: {
+    images: 'https://docs.sentry.io/changelog/assets/og.png',
+  },
+  other: {
+    'zd-site-verification': 'ocu6mswx6pke3c6qvozr2e',
   },
 };