feat(feedback): Add SDK docs for User Feedback by billyvg · Pull Request #8528 · getsentry/sentry-docs

billyvg · 2023-11-18T00:22:09Z

Adds SDK docs for new User Feedback widget (reorgs to support both old and new widgets). Adds setup page in product docs.

Closes #8494

vercel · 2023-11-18T00:22:15Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
sentry-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Dec 1, 2023 11:52pm

1 Ignored Deployment

Name	Status	Preview	Comments	Updated (UTC)
sentry-docs-next	⬜️ Ignored (Inspect)	Visit Preview		Dec 1, 2023 11:52pm

src/platforms/common/user-feedback/configuration.mdx

src/platforms/common/user-feedback/index.mdx

ryan953 · 2023-11-21T07:07:13Z

src/platforms/common/user-feedback/index.mdx

+
+</PlatformSection>
+
+<PlatformSection supported={["ruby.rails"]}>


Can we set the notSupported list (above) and supported list (here) on the same <PlatformSection>?

right now all this content is duplicated because ruby is not supported, but ruby.rails is supported :(

Unfortunately, we would need to hardcode in a list of all supported platforms, so if someone where to add in a new platform, it wouldn't be included here (this seems to have been done intentionally).

This might help in the future (https://github.com/getsentry/team-sdks/issues/35), for now we'll need to list all supported ones

Today we list all unsupported versions (once in a while it shows up where it shouldn't like new mobile SDKs, etc):

sentry-docs/src/platforms/common/enriching-events/user-feedback.mdx

Line 69 in 07bed55

<PlatformSection notSupported={["android", "apple", "java", "native", "dart", "flutter", "ruby", "unity", "react-native", "unreal", "kotlin-multiplatform"]}>

Yeah @billyvg - unfortunately, that's just how the SDK docs work at this point and even if it's awkward, it's best to be consistent.

FWIW, this was unchanged from how we were previously doing it: https://github.com/getsentry/sentry-docs/pull/8528/files#diff-494f8fd11fe7205c9ab2bdba2dfa76425b281dca0f3ed530072dbc24957fe990L133

billyvg · 2023-11-21T20:07:06Z

Closes #8494

src/docs/product/user-feedback/setup.mdx

vivianyentran · 2023-11-22T21:03:09Z

src/platforms/common/user-feedback/index.mdx

+
+## User Feedback API
+
+The user feedback API provides the ability to collect user information when an event occurs. You can use the same programming language you have in your app to send user feedback. In this case, the SDK creates the HTTP request so you don't have to deal with posting data via HTTP.


Maybe it's obvious to others, but I'd like more clarity here. How does the user feedback API connect to the widget? Can you use the widget without the API or do you need to set up both? The way it's described seems kinda similar to the crash report modal

+1 ^ @billyvg Is this section for the original Crash-Report modal? We should tweak that to make it obvious

@vivianyentran Thoughts on the new text?

The user feedback API allows you to collect user feedback while utilizing your own UI. You can use the same programming language you have in your app to send user feedback. In this case, the SDK creates the HTTP request so you don't have to deal with posting data via HTTP.

src/platforms/common/user-feedback/index.mdx

jas-kas · 2023-11-23T16:18:19Z

Reminder that we'll need to add Jesse's diagram of widget config options: getsentry/sentry#59941 (comment)

Presumably to this page - https://sentry-docs-57izufzsb.sentry.dev/platforms/javascript/user-feedback/configuration/

bruno-garcia · 2023-11-27T22:32:46Z

src/platforms/common/user-feedback/index.mdx

+
+</PlatformSection>
+
+<PlatformSection supported={["ruby.rails"]}>


I'll revisit this later to match all keys

Suggested change

<PlatformSection supported={["ruby.rails"]}>

<PlatformSection supported={["ruby.rails","node.express","python.flask","python.django","go","dotnet.aspnet","dotnet.aspnetcore","java.spring","java.spring-boot","php","javascript"]}>

shanamatthews

Sorry for lots of comments, it's all small stuff, just typos & style guide corrections.

src/platforms/common/user-feedback/index.mdx

src/includes/feature-stage-beta-user-feedback.mdx

src/platform-includes/user-feedback/pre-requisites/javascript.mdx

src/platforms/common/user-feedback/configuration.mdx

src/platforms/common/user-feedback/index.mdx

shanamatthews · 2023-12-01T21:51:10Z

src/platforms/common/user-feedback/index.mdx

+
+</PlatformSection>
+
+<PlatformSection supported={["ruby.rails"]}>


Yeah @billyvg - unfortunately, that's just how the SDK docs work at this point and even if it's awkward, it's best to be consistent.

src/platforms/common/user-feedback/index.mdx

billyvg · 2023-12-01T22:07:06Z

src/docs/product/user-feedback/user-feedback-widget.png

Note this will be added in #8539

Co-authored-by: Shana Matthews <shana.l.matthews@gmail.com>

src/includes/feature-stage-beta-user-feedback.mdx

src/platforms/common/user-feedback/index.mdx

src/platform-includes/user-feedback/pre-requisites/javascript.mdx

jas-kas · 2023-11-23T16:11:16Z

src/platforms/common/user-feedback/index.mdx

+
+## User Feedback API
+
+The user feedback API provides the ability to collect user information when an event occurs. You can use the same programming language you have in your app to send user feedback. In this case, the SDK creates the HTTP request so you don't have to deal with posting data via HTTP.


+1 ^ @billyvg Is this section for the original Crash-Report modal? We should tweak that to make it obvious

jas-kas · 2023-11-23T16:12:37Z

src/platforms/common/user-feedback/index.mdx

+
+<PlatformContent includePath="user-feedback/sdk-api-example" />
+
+Alternatively, you can use the [User Feedback API endpoint](/api/projects/submit-user-feedback/) directly.


This is a bit confusing to me bc the above section is about an API as well.

This is leftover from old docs, but the API endpoint is language agnostic, the [supported] SDK APIs is language specific and handles the network request to the endpoint

jas-kas · 2023-11-23T16:14:45Z

src/platforms/common/user-feedback/index.mdx

+
+## User Feedback API
+
+The user feedback API provides the ability to collect user information when an event occurs. You can use the same programming language you have in your app to send user feedback. In this case, the SDK creates the HTTP request so you don't have to deal with posting data via HTTP.


Similar to above, we show a crash-report modal screenshots -- lets do one from here: https://docs.sentry.io/platforms/javascript/enriching-events/user-feedback/?original_referrer=https%3A%2F%2Fwww.google.com%2F#embeddable-javascript-widget

The modal wont' be used if the user calls the API directly though

Co-authored-by: Shana Matthews <shana.l.matthews@gmail.com>

- Merge after getsentry/sentry-docs#8528 is merged - Closes https://github.com/getsentry/team-replay/issues/312

vercel bot had a problem deploying to Preview November 18, 2023 00:30 Failure

ryan953 reviewed Nov 20, 2023

View reviewed changes

src/platforms/common/user-feedback/configuration.mdx Outdated Show resolved Hide resolved

billyvg mentioned this pull request Nov 20, 2023

Rename onDialog* callbacks to onForm*, remove onActorClick getsentry/sentry-javascript#9605

Closed

ryan953 reviewed Nov 21, 2023

View reviewed changes

vercel bot had a problem deploying to Preview November 21, 2023 19:25 Failure

vercel bot deployed to Preview November 21, 2023 19:46 View deployment

vercel bot deployed to Preview November 21, 2023 23:03 View deployment

shanamatthews mentioned this pull request Nov 22, 2023

feat(feedback): Add onClose description to user-feedback #8484

Merged

3 tasks

vivianyentran reviewed Nov 22, 2023

View reviewed changes

vercel bot deployed to Preview November 23, 2023 16:11 View deployment

jas-kas self-requested a review November 23, 2023 16:18

bruno-garcia reviewed Nov 27, 2023

View reviewed changes

bruno-garcia mentioned this pull request Nov 27, 2023

feat(feedback): product docs #8539

Merged

vercel bot deployed to Preview – sentry-docs December 1, 2023 17:54 View deployment

billyvg and others added 12 commits December 1, 2023 13:12

feat(feedback): Add SDK docs for User Feedback [WIP]

d54127c

lint

566fa3e

move other user-feedback content

7a8ef85

update links

88d1741

crash report widget --> dialog

cf78ed0

language updates

f94015f

[getsentry/action-github-commit] Auto commit

bdd6662

add "Set up" under product/user feedback

36c33b7

update ror

65d8ae8

temp remove redirects for now

2278b46

dialog -> modal

3491879

review feedback

e24a440

vercel bot had a problem deploying to Preview – sentry-docs December 1, 2023 21:01 Failure

move redirects to vercel.json

7f589fc

vercel bot deployed to Preview – sentry-docs December 1, 2023 21:12 View deployment

shanamatthews approved these changes Dec 1, 2023

View reviewed changes

billyvg commented Dec 1, 2023

View reviewed changes

src/docs/product/user-feedback/user-feedback-widget.png

Copy link

Member Author

billyvg Dec 1, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note this will be added in #8539

billyvg and others added 3 commits December 1, 2023 17:11

Apply suggestions from code review

3cab54c

Co-authored-by: Shana Matthews <shana.l.matthews@gmail.com>

fix user widget png path

238ff17

update TODO

f8987eb

vercel bot deployed to Preview – sentry-docs December 1, 2023 22:22 View deployment

remove internal package

b6859ad

jas-kas approved these changes Dec 1, 2023

View reviewed changes

billyvg added 2 commits December 1, 2023 17:53

add framework specific

a49e503

update urls to user feedback

10bfaf8

billyvg changed the title ~~feat(feedback): Add SDK docs for User Feedback [WIP]~~ feat(feedback): Add SDK docs for User Feedback Dec 1, 2023

vercel bot deployed to Preview – sentry-docs December 1, 2023 23:05 View deployment

billyvg and others added 3 commits December 1, 2023 18:10

jasmin feedback

b190588

fix old enriching-events parent

d431edc

[getsentry/action-github-commit] Auto commit

2a65041

billyvg marked this pull request as ready for review December 1, 2023 23:19

billyvg requested a review from a team as a code owner December 1, 2023 23:19

Apply suggestions from code review

b40e09f

Co-authored-by: Shana Matthews <shana.l.matthews@gmail.com>

vercel bot deployed to Preview – sentry-docs December 1, 2023 23:34 View deployment

billyvg added 2 commits December 1, 2023 18:45

fix url

9a49eaa

no user feedback support for kotlin

5eb2cd2

vercel bot deployed to Preview – sentry-docs December 1, 2023 23:52 View deployment

michellewzhang mentioned this pull request Dec 4, 2023

ref(feedback): update feedback setup URL to link to docs getsentry/sentry#61080

Merged

bruno-garcia merged commit ded15e9 into master Dec 4, 2023

bruno-garcia deleted the feat-feedback-add-new-feedback-docs branch December 4, 2023 22:16

michellewzhang added a commit to getsentry/sentry that referenced this pull request Dec 4, 2023

ref(feedback): update feedback setup URL to link to docs (#61080)

3e5d243

- Merge after getsentry/sentry-docs#8528 is merged - Closes https://github.com/getsentry/team-replay/issues/312

github-actions bot locked and limited conversation to collaborators Dec 20, 2023


		</PlatformSection>

		<PlatformSection supported={["ruby.rails"]}>


		## User Feedback API

		The user feedback API provides the ability to collect user information when an event occurs. You can use the same programming language you have in your app to send user feedback. In this case, the SDK creates the HTTP request so you don't have to deal with posting data via HTTP.


		<PlatformContent includePath="user-feedback/sdk-api-example" />

		Alternatively, you can use the [User Feedback API endpoint](/api/projects/submit-user-feedback/) directly.

Uh oh!

Conversation

billyvg commented Nov 18, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vercel bot commented Nov 18, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

billyvg commented Nov 21, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

jas-kas commented Nov 23, 2023

Uh oh!

bruno-garcia Nov 27, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

shanamatthews left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

billyvg commented Nov 18, 2023 •

edited

Loading

vercel bot commented Nov 18, 2023 •

edited

Loading

bruno-garcia Nov 27, 2023 •

edited

Loading