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): document new feedback envelope format and rename old format #12188

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

Conversation

aliu39
Copy link
Member

@aliu39 aliu39 commented Dec 19, 2024

Copy link

vercel bot commented Dec 19, 2024

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

Name Status Preview Comments Updated (UTC)
develop-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 20, 2024 7:26pm
2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
changelog ⬜️ Ignored (Inspect) Visit Preview Dec 20, 2024 7:26pm
sentry-docs ⬜️ Ignored (Inspect) Visit Preview Dec 20, 2024 7:26pm

develop-docs/sdk/data-model/envelope-items.mdx Outdated Show resolved Hide resolved

**Attaching Screenshots:**

You can associate **up to 1** screenshot/image with a feedback by sending an
Copy link
Member

Choose a reason for hiding this comment

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

i thought we can attach multiple screenshots?🧐

Copy link
Member Author

Choose a reason for hiding this comment

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

I think we technically can, but the UI only displays one right?

Copy link
Member

Choose a reason for hiding this comment

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

no we can display multiple!

Copy link
Member Author

Choose a reason for hiding this comment

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

Oh nice! Is there a max number?

Copy link
Member

Choose a reason for hiding this comment

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

no max i believe

develop-docs/sdk/data-model/envelope-items.mdx Outdated Show resolved Hide resolved
develop-docs/sdk/data-model/envelope-items.mdx Outdated Show resolved Hide resolved

`url`

: *String, optional.* The URL of the referring webpage which may be used to search
Copy link
Member

Choose a reason for hiding this comment

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

"referring webpage" is a bit unclear, could we use some more specific wording here?

Copy link
Member Author

Choose a reason for hiding this comment

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

Do you have suggestions?
"The URL of the webpage from which the feedback was submitted from." ?
Flows a little weird

Copy link
Member

Choose a reason for hiding this comment

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

URL from which the feedback was submitted?
URL of the page the user was on when the feedback was submitted?

Copy link
Member Author

Choose a reason for hiding this comment

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

Changed to "The URL of the webpage the user was on when submitting feedback."

Although I like the original too. I think "referring webpage" hints at HTTP referrer, which I think this field is pretty similar to?

develop-docs/sdk/data-model/envelope-items.mdx Outdated Show resolved Hide resolved
develop-docs/sdk/data-model/envelope-items.mdx Outdated Show resolved Hide resolved
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.

Document protocol of new feedback: https://develop.sentry.dev/sdk/envelope-items/#user-feedback
2 participants