New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(feedback): Add UF screenshot capability #9867
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good!
docs/platforms/javascript/common/user-feedback/configuration/index.mdx
Outdated
Show resolved
Hide resolved
…ndex.mdx Co-authored-by: vivianyentran <[email protected]>
Co-authored-by: vivianyentran <[email protected]>
Bundle ReportChanges will decrease total bundle size by 12 bytes ⬇️
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
some small capitalization things
docs/platforms/javascript/common/user-feedback/configuration/index.mdx
Outdated
Show resolved
Hide resolved
Co-authored-by: Michelle Zhang <[email protected]>
looks good! i'm guessing we don't need to modify the code snippet itself to show this option bc it's set to 'true' behind-the-scenes? :D |
Yes! The code snippet will work with SDK v7 and v8 too since the screenshot option isn't needed there :D |
Co-authored-by: Jasmin <[email protected]>
…ndex.mdx Co-authored-by: Jasmin <[email protected]>
Co-authored-by: Michelle Zhang <[email protected]>
It seems to me we're missing a reference to it from the main product docs: https://sentry-docs-git-cl-uf-screenshot.sentry.dev/product/user-feedback/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could be done in a follow up PR, but we're missing product docs. Is that something @jas-kas is taking on?
@bruno-garcia There is a reference to screenshots in the main product docs. It's in the list of context collected. Let us know if you think more info is required on the main product docs and what that would be. I think it would be helpful to link out the SDK section on screenshots in the main product docs. |
Co-authored-by: Bruno Garcia <[email protected]>
Co-authored-by: Bruno Garcia <[email protected]>
<SignInNote /> | ||
|
||
<PlatformContent includePath="user-feedback/setup" /> | ||
|
||
By default, this will insert the widget into the bottom right corner of your website. You're free to customize nearly every aspect of the widget, including replacing it completely with your own UI. | ||
|
||
On SDK version 8.0.0 and above, users can send screenshots with their feedback. You can configure this using the `showScreenshot` option, by default it is set to `true`. Screenshots aren't supported on mobile devices, so the screenshot button will be hidden automatically in this case. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can we mention here (and on the config page above too) the min. version for on-prem users to have that enables screenshot support?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just to clarify, is on-prem the same as ST?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We've got:
- SaaS -> Software as a service, sentry.io where people signup and login on their own. There's a single database will all the orgs and users and so on saved.
- ST -> Single Tenant, a separate deployment of sentry that we (the company) manage. We run the servers, but the servers only store information for one company.
- On-Prem -> Someone downloads sentry from github and runs it themselves. This'll also (almost always) just have 1 org saved into the database.
S4S is an example of ST where we can deploy the sentry codebase and not affect sentry.io. ST and On-Prem have very similar configs, while the SaaS codebase is special because it has the extra billing layer added on top (all the features are the same everywhere though)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated! Feel free to make a suggestion if the wording is iffy
docs/platforms/javascript/common/user-feedback/configuration/index.mdx
Outdated
Show resolved
Hide resolved
…ndex.mdx Co-authored-by: Bruno Garcia <[email protected]>
Co-authored-by: Bruno Garcia <[email protected]>
* add screenshot to docs * Update docs/platforms/javascript/common/user-feedback/configuration/index.mdx Co-authored-by: vivianyentran <[email protected]> * Update docs/platforms/javascript/common/user-feedback/index.mdx Co-authored-by: vivianyentran <[email protected]> * Update docs/platforms/javascript/common/user-feedback/index.mdx Co-authored-by: Michelle Zhang <[email protected]> * Update docs/platforms/javascript/common/user-feedback/index.mdx Co-authored-by: Jasmin <[email protected]> * Update docs/platforms/javascript/common/user-feedback/configuration/index.mdx Co-authored-by: Jasmin <[email protected]> * Update docs/platforms/javascript/common/user-feedback/index.mdx Co-authored-by: Michelle Zhang <[email protected]> * Update docs/platforms/javascript/common/user-feedback/index.mdx Co-authored-by: Bruno Garcia <[email protected]> * Update index.mdx * Update docs/platforms/javascript/common/user-feedback/index.mdx Co-authored-by: Bruno Garcia <[email protected]> * Update index.mdx * Update index.mdx * Update docs/platforms/javascript/common/user-feedback/configuration/index.mdx Co-authored-by: Bruno Garcia <[email protected]> * Update docs/platforms/javascript/common/user-feedback/index.mdx Co-authored-by: Bruno Garcia <[email protected]> * screenshots * showscreenshot renamed + pr comment * Update index.mdx * Update index.mdx * Update index.mdx * update screenshots * hopefully last modification --------- Co-authored-by: vivianyentran <[email protected]> Co-authored-by: Jasmin <[email protected]> Co-authored-by: Michelle Zhang <[email protected]> Co-authored-by: Bruno Garcia <[email protected]>
Mention screenshot capabilities and documents how to configure screenshots in the Javascript SDK docs and UF product docs. Also adds screenshot configuration option in feedback configure docs.
Closes #9801
Fixes getsentry/sentry#64701
Do not merge until User Feedback is GA