Skip to content
This repository has been archived by the owner on Aug 14, 2024. It is now read-only.

feat(feedback): add page for feedback architecture #1313

Merged
merged 31 commits into from
Jun 26, 2024
Merged
Changes from 1 commit
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
4c81d4c
feat(feedback): add a page for feedback architecture
aliu39 Jun 18, 2024
c3855f4
Camelcase for model name
aliu39 Jun 18, 2024
ae5ad5a
Add diagrams
aliu39 Jun 18, 2024
30a4abe
Add some whitespace
aliu39 Jun 18, 2024
ed571d7
Header capitalizion
aliu39 Jun 18, 2024
079d727
Update src/docs/feedback-architecture.mdx
aliu39 Jun 24, 2024
9b86a46
Update src/docs/feedback-architecture.mdx
aliu39 Jun 24, 2024
4b3e78b
Update src/docs/feedback-architecture.mdx
aliu39 Jun 24, 2024
b23ba08
Update src/docs/feedback-architecture.mdx
aliu39 Jun 24, 2024
fbd89ee
Update src/docs/feedback-architecture.mdx
aliu39 Jun 24, 2024
6c671c5
Update src/docs/feedback-architecture.mdx
aliu39 Jun 24, 2024
09c262f
Update src/docs/feedback-architecture.mdx
aliu39 Jun 24, 2024
977c626
Add to bottom of sidebar as 'User Feedback Architecture'
aliu39 Jun 24, 2024
79dcaec
Make diagrams light mode
aliu39 Jun 24, 2024
2f5f833
Tweak ##Creation sources wording
aliu39 Jun 24, 2024
d4c614d
Add links to envelope formats in Creation sources + some more tweaks
aliu39 Jun 24, 2024
e7eaa9e
Code-ify user_report
aliu39 Jun 24, 2024
ff89364
Reword mistakenly
aliu39 Jun 24, 2024
6738d24
Tweak diagrams: envelopes->envelope and rm widget/api from first graph
aliu39 Jun 24, 2024
d87a8fc
Reword user report endpoint
aliu39 Jun 24, 2024
222c37a
Merge branch 'master' into aliu/feedback-arch
aliu39 Jun 24, 2024
079470e
Add crash reports section
aliu39 Jun 24, 2024
8ea0346
Split up diagrams and finalize
aliu39 Jun 25, 2024
2be8544
Tweak feedback envelope
aliu39 Jun 25, 2024
9090d24
Update report diagram
aliu39 Jun 25, 2024
18f4d70
Merge branch 'aliu/feedback-arch' of https://github.com/getsentry/dev…
aliu39 Jun 25, 2024
35b6d6f
Update title
aliu39 Jun 25, 2024
e81a031
Add ff's
aliu39 Jun 25, 2024
638ddda
Use bullet points
aliu39 Jun 25, 2024
2801d44
Tweak ff descrip
aliu39 Jun 25, 2024
ec245b6
Final tweaks
aliu39 Jun 26, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add crash reports section
  • Loading branch information
aliu39 committed Jun 24, 2024
commit 079470e9ec3eb93fbe5d3cacc534854c277aaa57
28 changes: 19 additions & 9 deletions src/docs/feedback-architecture.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -138,20 +138,30 @@ to Sentry, with
`/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/user-feedback/`.

See [https://docs.sentry.io/api/projects/submit-user-feedback/](https://docs.sentry.io/api/projects/submit-user-feedback/).
<br/>

### Crash reports
---

## Crash reports

The crash report modal is a Django view -- an HTML form your app can render when
a page crashes. This was the earliest way of collecting feedback, and is for
submitting feedback when Sentry detects an error. You can install it as an [SDK integration](https://docs.sentry.io/platforms/javascript/user-feedback/#crash-report-modal).
The **crash report modal** pops up when Sentry detects an error on the current
page, prompting users to describe what happened. On the backend, crash report
data is the same as user reports.

URL: `/api/embed/error-page/`
You can install it as an [SDK integration](https://docs.sentry.io/platforms/javascript/user-feedback/#crash-report-modal).

We implement it as a Django view:
* URL: `/api/embed/error-page/`
* Python Class: `error_page_embed.ErrorPageEmbedView`

Crash reports are also shimmed to feedback. The pipeline is the same as the
`/user-feedback` endpoint.
<br/>

Python Class: `error_page_embed.ErrorPageEmbedView`
### Sentry UI

Crash reports are also shimmed to feedback. The pipeline is very similar to the
Django endpoint.
You can view the crash reports tied to an issue at the "User Feedback" tab of
the Issue Details page. This also includes user reports submitted with the
old feedback API.

---

Expand Down