Skip to content

Commit 75ce009

Browse files
committed
Merge branch 'master' into abhi-logs-sdk-developer-documentation
2 parents 9a130c1 + 19670cc commit 75ce009

File tree

209 files changed

+5279
-1534
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

209 files changed

+5279
-1534
lines changed

.github/workflows/algolia-index.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,8 @@ jobs:
4848
DOCS_INDEX_NAME: ${{ secrets.DOCS_INDEX_NAME }}
4949
NEXT_PUBLIC_ALGOLIA_APP_ID: ${{ secrets.NEXT_PUBLIC_ALGOLIA_APP_ID }}
5050
NEXT_PUBLIC_ALGOLIA_SEARCH_KEY: ${{ secrets.NEXT_PUBLIC_ALGOLIA_SEARCH_KEY }}
51+
SENTRY_DSN: https://[email protected]/0
52+
NEXT_PUBLIC_SENTRY_DSN: https://[email protected]/0
5153

5254
- name: Build index for developer docs
5355
run: yarn build:developer-docs && bun ./scripts/algolia.ts
@@ -58,4 +60,6 @@ jobs:
5860
DOCS_INDEX_NAME: ${{ secrets.DEVELOP_DOCS_INDEX_NAME }}
5961
NEXT_PUBLIC_ALGOLIA_APP_ID: ${{ secrets.NEXT_PUBLIC_ALGOLIA_APP_ID }}
6062
NEXT_PUBLIC_ALGOLIA_SEARCH_KEY: ${{ secrets.NEXT_PUBLIC_ALGOLIA_SEARCH_KEY }}
63+
SENTRY_DSN: https://[email protected]/0
64+
NEXT_PUBLIC_SENTRY_DSN: https://[email protected]/0
6165
NEXT_PUBLIC_DEVELOPER_DOCS: 1

.github/workflows/lint-404s.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,13 +40,22 @@ jobs:
4040

4141
- run: yarn build
4242
if: steps.filter.outputs.docs == 'true'
43+
env:
44+
SENTRY_DSN: https://[email protected]/0
45+
NEXT_PUBLIC_SENTRY_DSN: https://[email protected]/0
4346

4447
- run: yarn build:developer-docs
4548
if: steps.filter.outputs.dev-docs == 'true'
49+
env:
50+
SENTRY_DSN: https://[email protected]/0
51+
NEXT_PUBLIC_SENTRY_DSN: https://[email protected]/0
4652

4753
- name: Start Http Server
4854
run: yarn start &
4955
if: steps.filter.outputs.docs == 'true' || steps.filter.outputs.dev-docs == 'true'
56+
env:
57+
SENTRY_DSN: https://[email protected]/0
58+
NEXT_PUBLIC_SENTRY_DSN: https://[email protected]/0
5059

5160
- name: Lint 404s
5261
run: bun ./scripts/lint-404s/main.ts

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ import {isDeveloperDocs} from 'sentry-docs/isDeveloperDocs';
2222
import {
2323
getDevDocsFrontMatter,
2424
getDocsFrontMatter,
25-
getFileBySlug,
25+
getFileBySlugWithCache,
2626
getVersionsFromDoc,
2727
} from 'sentry-docs/mdx';
2828
import {mdxComponents} from 'sentry-docs/mdxComponents';
@@ -106,9 +106,9 @@ export default async function Page(props: {params: Promise<{path?: string[]}>})
106106

107107
if (isDeveloperDocs) {
108108
// get the MDX for the current doc and render it
109-
let doc: Awaited<ReturnType<typeof getFileBySlug>> | null = null;
109+
let doc: Awaited<ReturnType<typeof getFileBySlugWithCache>>;
110110
try {
111-
doc = await getFileBySlug(`develop-docs/${params.path?.join('/') ?? ''}`);
111+
doc = await getFileBySlugWithCache(`develop-docs/${params.path?.join('/') ?? ''}`);
112112
} catch (e) {
113113
if (e.code === 'ENOENT') {
114114
// eslint-disable-next-line no-console
@@ -144,9 +144,9 @@ export default async function Page(props: {params: Promise<{path?: string[]}>})
144144
}
145145

146146
// get the MDX for the current doc and render it
147-
let doc: Awaited<ReturnType<typeof getFileBySlug>> | null = null;
147+
let doc: Awaited<ReturnType<typeof getFileBySlugWithCache>>;
148148
try {
149-
doc = await getFileBySlug(`docs/${pageNode.path}`);
149+
doc = await getFileBySlugWithCache(`docs/${pageNode.path}`);
150150
} catch (e) {
151151
if (e.code === 'ENOENT') {
152152
// eslint-disable-next-line no-console

apps/changelog/package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@
2525
"@radix-ui/react-icons": "^1.3.2",
2626
"@radix-ui/react-toolbar": "^1.1.0",
2727
"@radix-ui/themes": "^3.1.3",
28-
"@sentry/nextjs": "9.7.0-alpha.0",
28+
"@sentry/nextjs": "9.10.1",
2929
"@spotlightjs/spotlight": "^2.1.1",
30-
"next": "15.1.2",
30+
"next": "15.2.3",
3131
"next-auth": "^4.24.5",
3232
"next-mdx-remote": "^4.4.1",
3333
"next-plausible": "^3.12.4",
@@ -68,4 +68,4 @@
6868
"@types/react": "npm:[email protected]",
6969
"@types/react-dom": "npm:[email protected]"
7070
}
71-
}
71+
}

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export default async function ChangelogCreatePage(props: {
2828
<h2>Changelog not found</h2>
2929
</header>
3030
<footer>
31-
<Link href="/changelogs">Return to Changelogs list</Link>
31+
<Link href="/changelog/_admin">Return to Changelogs list</Link>
3232
</footer>
3333
</Fragment>
3434
);

apps/changelog/src/client/components/navbar.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -501,7 +501,7 @@ const NAV_ITEMS: NavItemsProps[] = [
501501
id: 'sandbox',
502502
title: 'Sandbox',
503503
type: 'a',
504-
to: 'https://try.sentry-demo.com/demo/start/',
504+
to: 'https://sandbox.sentry.io/',
505505
target: '_blank',
506506
variant: 'ghost',
507507
className: '',

apps/changelog/sentry.client.config.ts renamed to apps/changelog/src/instrumentation-client.ts

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
// This file configures the initialization of Sentry on the client.
2-
// The config you add here will be used whenever a users loads a page in their browser.
3-
// https://docs.sentry.io/platforms/javascript/guides/nextjs/
4-
51
import * as SentryCore from '@sentry/core';
62
import * as Sentry from '@sentry/nextjs';
73
import * as Spotlight from '@spotlightjs/spotlight';

develop-docs/backend/application-domains/database-migrations/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -134,9 +134,9 @@ This is complicated due to our deploy process. When we deploy, we run migrations
134134

135135
To avoid this, follow these steps:
136136

137-
- Make a PR to remove all uses of the column in the codebase in a separate PR. This mostly helps with code cleanliness. This should be merged ahead of the migration prs, but we don't need to worry about whether it is deployed first.
137+
- First, if the column is either not nullable, or doesn't have a `db_default` set, then make a PR to make it nullable via `null=True`.
138+
- Then, remove all uses of the column in the codebase in a separate PR; this mostly helps with code cleanliness. This should be merged ahead of the next migration PRs, but we don't need to worry about whether it is deployed first.
138139
- Make another PR that:
139-
- Checks if the column is either not nullable, or doesn't have a `db_default` set. If either of these is true, then make it nullable via `null=True`.
140140
- If the column is a foreign key, remove the database level foreign key constraint it by setting `db_constraint=False`.
141141
- Remove the column and in the generated migration use `SafeRemoveField(..., deletion_action=DeletionAction.MOVE_TO_PENDING)` to replace `RemoveField(...)`. This only marks the state for the column as removed.
142142
- Combine these migrations together to save making multiple deploys

develop-docs/development-infrastructure/continuous-integration.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ You might also be interested in <Link to="/development/environment/#troubleshoot
3232

3333
**Problem:**
3434

35-
When pushing your build to staging and you it fails the `Ensure test image` step on Travis.
35+
When pushing your build to staging and it fails the `Ensure test image` step on Travis.
3636

3737
**Solution:**
3838

develop-docs/integrations/pagerduty.mdx

Lines changed: 16 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -6,35 +6,28 @@ sidebar_title: PagerDuty
66
## Create a PagerDuty app
77
In PagerDuty, go to `https://{YOUR_PAGERDUTY_SUBDOMAIN}.pagerduty.com/developer/applications`.
88

9-
Select __Create New App__.
9+
Click on __New App__, and configure the _Info & Functionality_ section as follows:
1010

11-
When configuring the app, use the following values:
11+
| Setting | Value |
12+
| ------------- | ------------------------------- |
13+
| Name | Sentry |
14+
| Description | Trigger alerts through Sentry |
15+
| Functionality | Events Integration |
1216

13-
| Setting | Value |
14-
| ------------------------------------------------------------------------------------------------------ | --------------------------------------------- |
15-
| App Name | Sentry |
16-
| Brief Description | Trigger alerts through Sentry |
17-
| Category | Error tracking |
18-
| Do you intend to publish the app for all PagerDuty users and the app ecosystem? | No, I am not interested |
17+
Afterward, click __Next__, and configure the _Events Integration_ section as follows:
1918

20-
## Configure the PagerDuty app
21-
On the resulting configuration page in PagerDuty, under __Functionality > Events Integration__, click on __Add__.
19+
| Setting | Value |
20+
| --------------------------------------- | ---------------------------------------------------- |
21+
| Transform Event Data | No |
22+
| Send Change Events | No |
23+
| Simple Install Flow > Redirect URLs | `{YOUR_SENTRY_DOMAIN}/extensions/pagerduty/setup/` |
2224

23-
When configuring the events integration, use the following values:
25+
Next, click __Register App__, to complete the setup, and be redirected to the app registration page.
2426

25-
| Setting | Value |
26-
| ------------------------------- | --------------------------------------------- |
27-
| Transform Event Data | No |
28-
| Change Events | No |
29-
| Redirect URLs | `{YOUR_DOMAIN}/extensions/pagerduty/setup/` |
27+
Find your newly created app, and copy down the value in the _App ID_ field (e.g. `PV5SD0T`)
3028

31-
At this point, note the __Integration Setup URL__. It should look something like this: `app.pagerduty.com/install/integration?app_id=PV5SD0T&redirect_url={YOUR_DOMAIN}/extensions/pagerduty/setup/&version=2`
32-
33-
Copy the App ID (in this case `PV5SD0T`).
34-
35-
## Enable the integration in Sentry
36-
37-
Add the App ID to your `config.yml` for Sentry:
29+
## Connect your PagerDuty App to your Sentry instance
30+
Add the _App ID_ to your `config.yml` for Sentry:
3831

3932
```yml
4033
pagerduty.app-id: 'PV5SD0T'

0 commit comments

Comments
 (0)