sentry-docs icon indicating copy to clipboard operation
sentry-docs copied to clipboard

Add User Feedback section for Rails

Open MatthiasPortzel opened this issue 3 years ago • 7 comments

Adds information on integrating the JavaScript User Feedback SDK into a Rails app. It's modeled off the existing Python documentation.

It also serves as a way to document the env variable sentry.error_event_id which was added in https://github.com/getsentry/sentry-ruby/pull/1849 (CC: @st0012).

This has the unfortunate side-effect of populating the Ruby-only version of this page, when the Ruby SDK doesn't actually support user feedback. But there's no easy way to show this page for Rails and not Ruby. Python also has the same problem, so I don't think this should block merging.

I recently implemented the described behavior in our Rails app, so I thought I'd add a couple words to the documentation. Feedback is welcome.

Legal Boilerplate

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

MatthiasPortzel avatar Aug 17 '22 02:08 MatthiasPortzel

@MatthiasPortzel is attempting to deploy a commit to the Sentry Team on Vercel.

A member of the Team first needs to authorize it.

vercel[bot] avatar Aug 17 '22 02:08 vercel[bot]

@sl0thentr0py can you take a look? thx

st0012 avatar Aug 17 '22 08:08 st0012

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

Name Status Preview Updated
sentry-docs ✅ Ready (Inspect) Visit Preview Aug 19, 2022 at 8:16PM (UTC)

vercel[bot] avatar Aug 17 '22 12:08 vercel[bot]

This has the unfortunate side-effect of populating the Ruby-only version of this page, when the Ruby SDK doesn't actually support user feedback. But there's no easy way to show this page for Rails and not Ruby. Python also has the same problem, so I don't think this should block merging.

I'm gonna pull in your branch into my local to test a way around this; if it works, I'll push it. I'll circle back to do review of this PR for wording after that!

imatwawana avatar Aug 17 '22 15:08 imatwawana

I've made a very ugly hack, but it resolves the issue of having the content show up for Ruby when it's only supported on Rails.

imatwawana avatar Aug 17 '22 16:08 imatwawana

@MatthiasPortzel - can I commit my suggestions and get this merged for you?

imatwawana avatar Aug 19 '22 17:08 imatwawana

Yes, your changes sound good. Thanks.

MatthiasPortzel avatar Aug 19 '22 17:08 MatthiasPortzel