Skip to content
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

Merged
merged 21 commits into from May 9, 2024
Merged

Conversation

c298lee
Copy link
Member

@c298lee c298lee commented Apr 30, 2024

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

@c298lee c298lee requested review from jas-kas and a team April 30, 2024 06:15
Copy link

vercel bot commented Apr 30, 2024

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 May 9, 2024 3:16pm

@c298lee c298lee marked this pull request as draft April 30, 2024 06:16
@c298lee c298lee marked this pull request as ready for review April 30, 2024 16:11
Copy link
Contributor

@vivianyentran vivianyentran left a comment

Choose a reason for hiding this comment

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

Looks good!

Copy link

codecov bot commented Apr 30, 2024

Bundle Report

Changes will decrease total bundle size by 12 bytes ⬇️

Bundle name Size Change
sentry-docs-server 7.15MB 3 bytes ⬇️
sentry-docs-edge-server 427.92kB 3 bytes ⬇️
sentry-docs-client 5.77MB 6 bytes ⬇️

Copy link
Member

@michellewzhang michellewzhang left a 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/index.mdx Outdated Show resolved Hide resolved
docs/platforms/javascript/common/user-feedback/index.mdx Outdated Show resolved Hide resolved
@jas-kas
Copy link
Member

jas-kas commented May 1, 2024

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

@c298lee
Copy link
Member Author

c298lee commented May 1, 2024

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

@bruno-garcia
Copy link
Member

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/

Copy link
Member

@bruno-garcia bruno-garcia left a 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?

docs/platforms/javascript/common/user-feedback/index.mdx Outdated Show resolved Hide resolved
docs/platforms/javascript/common/user-feedback/index.mdx Outdated Show resolved Hide resolved
@jas-kas
Copy link
Member

jas-kas commented May 2, 2024

@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.

image

<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.
Copy link
Member

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?

Copy link
Member Author

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?

Copy link
Member

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)

Copy link
Member Author

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

@c298lee c298lee merged commit 6c02ad1 into master May 9, 2024
6 checks passed
@c298lee c298lee deleted the cl/uf-screenshot branch May 9, 2024 15:24
antonpirker pushed a commit that referenced this pull request May 14, 2024
* 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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add Screenshot Capability to Docs Document how to get it on Self-Hosted (needed for Single Tenant)
7 participants