Skip to content

Commit 747f4e8

Browse files
authored
[Develop Docs] Clean up "SDK Development" Sidebar (#11542)
Organize the information in the "SDK Development" section of the develop docs better.
1 parent f2b2d2d commit 747f4e8

File tree

194 files changed

+792
-691
lines changed

Some content is hidden

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

194 files changed

+792
-691
lines changed

develop-docs/application/feedback-architecture.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,12 @@ When broken down, there are **5** ways to create feedback in our system 😵‍
1515
`FeedbackCreationSource(Enum)` in [create_feedback.py](https://github.com/getsentry/sentry/blob/2b642e149c79b251e1c2f4339fc73d656347d74e/src/sentry/feedback/usecases/create_feedback.py#L33-L33).
1616
The 4 ways _clients_ can create feedback are:
1717

18-
`NEW_FEEDBACK_ENVELOPE`: [The new format](https://develop.sentry.dev/sdk/envelopes/#full-examples) created by the Replay team when adding
18+
`NEW_FEEDBACK_ENVELOPE`: [The new format](https://develop.sentry.dev/sdk/data-model/envelopes/#full-examples) created by the Replay team when adding
1919
the [User Feedback Widget](https://docs.sentry.io/product/user-feedback/#user-feedback-widget)
2020
to the JavaScript SDK. It allows adding more information, for example tags,
2121
release, url, etc.
2222

23-
`USER_REPORT_ENVELOPE`: [The older format](https://develop.sentry.dev/sdk/envelopes/#user-feedback) with name/email/comments, that requires
23+
`USER_REPORT_ENVELOPE`: [The older format](https://develop.sentry.dev/sdk/data-model/envelope-items/#user-feedback) with name/email/comments, that requires
2424
`event_id` to link a Sentry error event.
2525

2626
`USER_REPORT_DJANGO_ENDPOINT`: [The deprecated Web API](https://docs.sentry.io/api/projects/submit-user-feedback/)
@@ -41,7 +41,7 @@ which
4141

4242
## Feedback events
4343

44-
The new and preferred way to send feedback from the SDK is in an [event envelope](https://develop.sentry.dev/sdk/envelopes/#full-examples).
44+
The new and preferred way to send feedback from the SDK is in an [event envelope](https://develop.sentry.dev/sdk/data-model/envelopes/#full-examples).
4545
The format is the same as error events, except the `type` header = `"feedback"`. While
4646
user reports have an associated event, **new feedback _is_ an event**. This
4747
offers 2 improvements:
@@ -84,7 +84,7 @@ In Relay v24.5.1, we migrated feedback to its own kafka topic + consumer,
8484
### Attachments
8585

8686
We only use attachments for the widget’s screenshot feature, which allows users
87-
to submit **at most 1 screenshot per feedback**. Attachments are another [item type](https://develop.sentry.dev/sdk/envelopes/#attachment)
87+
to submit **at most 1 screenshot per feedback**. Attachments are another [item type](https://develop.sentry.dev/sdk/data-model/envelopes/#attachment)
8888
in an envelope.
8989

9090
- SDK v8.0.0+, Relay v24.5.1+: Sends the feedback and attachment items in the same envelope.
@@ -139,7 +139,7 @@ Simplified diagram:
139139

140140
### Envelopes
141141

142-
User reports are also sent to Relay in [envelope format](https://develop.sentry.dev/sdk/envelopes/#user-feedback).
142+
User reports are also sent to Relay in [envelope format](https://develop.sentry.dev/sdk/data-model/envelope-items/#user-feedback).
143143
**This item type is misleadingly called “user feedback” in some of our docs, but the
144144
item header will read `"user_report"`.**
145145

develop-docs/application/issue-platform/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ The most current version of this schema is documented here:
143143
Schema
144144
</Link>
145145

146-
The event schema should match the <Link to="/sdk/event-payloads">Sentry event schema</Link>. Any fields/interfaces defined here can be passed along with your event. It's best to fill in as many of these as makes sense for your issue type.
146+
The event schema should match the <Link to="/sdk/data-model/event-payloads/">Sentry event schema</Link>. Any fields/interfaces defined here can be passed along with your event. It's best to fill in as many of these as makes sense for your issue type.
147147

148148
There's a minimum set of fields which should be included:
149149

develop-docs/application/transaction-clustering/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ In terms of technical implementation, it is similar to [Data Scrubbing](/pii/).
1212
## The Problem
1313

1414
In our [Performance](https://docs.sentry.io/product/performance/) product, transactions are grouped by their name
15-
(the [`event.transaction`](/sdk/event-payloads/#optional-attributes) field).
15+
(the [`event.transaction`](/sdk/data-model/event-payloads/#optional-attributes) field).
1616
This works well as long as the cardinality of distinct transaction names that the SDK sends is low, for example
1717
by using the [route of a web framework](https://docs.sentry.io/platforms/javascript/guides/react/configuration/integrations/react-router/) as the transaction name.
1818

0 commit comments

Comments
 (0)