Skip to content

Commit bb02c35

Browse files
committed
Merge branch 'master' of github.com:getsentry/sentry-docs into smi/quick-start/react-manual
2 parents a0ec11d + 78fc097 commit bb02c35

File tree

128 files changed

+1402
-517
lines changed

Some content is hidden

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

128 files changed

+1402
-517
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

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: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
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.9.0",
28+
"@sentry/nextjs": "9.10.1",
2929
"@spotlightjs/spotlight": "^2.1.1",
3030
"next": "15.2.3",
3131
"next-auth": "^4.24.5",
@@ -68,4 +68,4 @@
6868
"@types/react": "npm:[email protected]",
6969
"@types/react-dom": "npm:[email protected]"
7070
}
71-
}
71+
}

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/sdk/data-model/event-payloads/contexts.mdx

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ related to the current user and the environment. For example, the device or
88
application version. Its canonical name is `contexts`.
99

1010
The `contexts` type can be used to define arbitrary contextual data on the
11-
event. It accepts an object of key/value pairs. The key is the alias of the
11+
event. It accepts an object of key/value pairs. The key is the "alias" of the
1212
context and can be freely chosen. However, as per policy, it should match the
1313
type of the context unless there are two values for a type. You can omit `type`
1414
if the key name is the type.
@@ -273,7 +273,7 @@ To summarize:
273273

274274
: _Optional_. Typically provides the full name, full version, and release alias. This maps to `PRETTY_NAME` in [`/etc/os-release`](https://www.freedesktop.org/software/systemd/man/latest/os-release.html#PRETTY_NAME=) (examples: `Ubuntu 22.04.4 LTS`, `Raspian GNU/Linux 10 (buster)`).
275275

276-
### Example OS Context
276+
**Example OS Context**
277277

278278
The OS Context for the 3 major OSs should look like this:
279279

@@ -468,7 +468,7 @@ Examples: `"Apple Metal"` or `"Direct3D11"`
468468

469469
: _Optional_. Are geometry shaders available on the device?
470470

471-
### Example GPU Context
471+
**Example GPU Context**
472472

473473
```json
474474
{
@@ -496,7 +496,7 @@ The `type` and default key is `"state"`.
496496

497497
: **Required**. Object with two keys: _Optional_ `type` for naming the state library (e.g.: Redux, MobX, Vuex) and **Required** `value` that holds the state object.
498498

499-
### Example State Context
499+
**Example State Context**
500500

501501
```json
502502
{
@@ -598,7 +598,7 @@ The `type` and default key is `"cloud_resource"`.
598598

599599
- Example: `t4g.medium`
600600

601-
### Example Cloud Resource Context
601+
**Example Cloud Resource Context**
602602

603603
The following example illustrates the contexts part of the <Link to="/sdk/data-model/event-payloads/">event payload</Link> and omits other attributes for simplicity.
604604

@@ -720,7 +720,7 @@ The `route` currently supports the following predefined fields if it's a map:
720720

721721
If the route is set to a string (e.g. `"route": "foo"`), it will be normalized into a map (e.g. `"route": {"name": "foo"}`) server-side.
722722

723-
### Example Trace Context
723+
**Example Trace Context**
724724

725725
```json
726726
{
@@ -766,7 +766,7 @@ envelope endpoint.
766766

767767
: **Required**. The replay_id associated with the event.
768768

769-
### Example Replay Context
769+
**Example Replay Context**
770770

771771
```json
772772
{
@@ -792,7 +792,7 @@ This is mostly set on transactions in a web server environment where one transac
792792

793793
- Example: `200`
794794

795-
### Example Response Context
795+
**Example Response Context**
796796

797797
```json
798798
{
@@ -822,7 +822,7 @@ The required field is `package` which should contain the package or framework wh
822822

823823
- Example: `true`
824824

825-
### Example Response Context
825+
**Example Response Context**
826826

827827
```json
828828
{
@@ -852,7 +852,7 @@ The feature flag context contains information about the flags evaluated prior to
852852
- Example: `false`
853853

854854

855-
### Example Feature Flag Context
855+
**Example Feature Flag Context**
856856

857857
```json
858858
{

docs/concepts/migration/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Below is a non-exhaustive list of some items that will not be relocated:
4848
- Issues
4949
- Events
5050
- Replays and/or other [Event Attachments](/platforms/javascript/enriching-events/attachments/)
51-
- Source Maps, [Debug Information Files](/cli/dif/) and/or [Artifact Bundles](/platforms/javascript/sourcemaps/troubleshooting_js/artifact-bundles/)
51+
- Source Maps, [Debug Information Files](/cli/dif/) and/or [Debug IDs](/platforms/javascript/sourcemaps/troubleshooting_js/debug-ids/)
5252
- Release information, including any references to external repositories via specific Pull Requests
5353
- Deployment information
5454
- Custom Avatars

docs/concepts/search/searchable-properties/session-replay.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -226,9 +226,9 @@ A release is a version of your code deployed to an environment. You can create a
226226

227227
- **Type:** string
228228

229-
### `replayType`
229+
### `replay_type`
230230

231-
The reason a replay was triggered. For example, `session` when `replaysSessionSampleRate` takes effect, or `error` when `replaysOnErrorSampleRate` is sampled instead of `session`.
231+
The reason a replay was triggered. For example, `session` when `replaysSessionSampleRate` takes effect, or `buffer` when `replaysOnErrorSampleRate` is sampled instead of `session`. Learn more in the [Session Replay docs](/platforms/javascript/session-replay/understanding-sessions/).
232232

233233
- **Type:** string
234234

docs/contributing/pages/components.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,12 @@ Render an expandable section to provide additional information to users on deman
130130
provide optional information that can help users be more successful.
131131
</Expandable>
132132

133+
<Expandable title="Expandable with a code block">
134+
```js
135+
const foo = 'bar';
136+
```
137+
</Expandable>
138+
133139
```markdown {tabTitle:Example}
134140
<Expandable title="Here's something worth noting">
135141
This is an expandable section in an `'info'` alert style.

0 commit comments

Comments
 (0)