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

Cocoa User Feedback #11191

Open
wants to merge 8 commits into
base: master
Choose a base branch
from

Conversation

armcknight
Copy link
Member

@armcknight armcknight commented Aug 29, 2024

DESCRIBE YOUR PR

Documents a new feature for gathering User Feedback in a Cocoa app, based on the similar feature we already ship in e.g. sentry-javascript. Used https://docs.sentry.io/platforms/javascript/user-feedback/ as inspiration.

sentry-cocoa PR that declares the API: getsentry/sentry-cocoa#4284; tracking work at getsentry/sentry-cocoa#4269

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • None: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
    Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Make sure we have the correct SDK version in the Installation sectioun
  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

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.

EXTRA RESOURCES

Copy link

vercel bot commented Aug 29, 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 Jan 11, 2025 2:24am
2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
changelog ⬜️ Ignored (Inspect) Visit Preview Jan 11, 2025 2:24am
develop-docs ⬜️ Ignored (Inspect) Visit Preview Jan 11, 2025 2:24am

Copy link

codecov bot commented Aug 29, 2024

Bundle Report

Changes will increase total bundle size by 225 bytes (0.0%) ⬆️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-server-cjs 10.37MB 231 bytes (0.0%) ⬆️
sentry-docs-client-array-push 9.3MB 6 bytes (-0.0%) ⬇️

@armcknight armcknight changed the title wip Cocoa User Feedback Aug 29, 2024
@armcknight armcknight marked this pull request as ready for review September 3, 2024 19:39
@armcknight armcknight marked this pull request as draft September 3, 2024 19:40
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.

Thanks for adding!

docs/platforms/apple/common/user-feedback/index.mdx Outdated Show resolved Hide resolved
docs/platforms/apple/common/user-feedback/index.mdx Outdated Show resolved Hide resolved
@getsantry

This comment was marked as outdated.

@getsantry getsantry bot added Stale and removed Stale labels Sep 25, 2024
@getsantry

This comment was marked as outdated.

@getsantry getsantry bot added Stale and removed Stale labels Oct 18, 2024
@coolguyzone

This comment was marked as outdated.

@getsantry

This comment was marked as outdated.

@getsantry getsantry bot added Stale and removed Stale labels Nov 22, 2024
@getsantry

This comment was marked as outdated.

@getsantry getsantry bot added Stale and removed Stale labels Dec 15, 2024
@getsantry

This comment was marked as outdated.

@getsantry getsantry bot added Stale and removed Stale labels Jan 7, 2025
@armcknight
Copy link
Member Author

Hi @coolguyzone , sorry I missed your message. Yes, I'm preparing to merge this PR now.


### Session Replay

The User Feedback widget integrates seamlessly with Session Replay. When the widget is opened, the Replay SDK buffers up to 30 seconds of the user's session. If feedback is submitted, this replay is sent along with the feedback, allowing you to view both the feedback and the user's actions leading up to the feedback submission.
Copy link
Member Author

Choose a reason for hiding this comment

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

@bruno-garcia @brustolin I'm not sure if the 30 second thing checks out or not. All I'm doing is attaching any available session replay id when I package the envelope. Let me know if we need to look into this some more.

@armcknight
Copy link
Member Author

@bruno-garcia I think the two index.mdx could actually be combined here. Also, I removed the docs for crash dialogs, as I haven't implemented anything like that.

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.

4 participants