docs(feedback): Keep SDK v7 config docs #10009

ryan953 · 2024-05-13T23:33:04Z

This is restoring content that we had before, specific to the v7 JS SDK.

The only changes I made are to fix the links, using PlatformLink properly.
This was originally removed/replaced in #9961 as we launched v8

vercel · 2024-05-13T23:33:07Z

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 20, 2024 6:32pm

codecov · 2024-05-13T23:38:46Z

Bundle Report

Changes will increase total bundle size by 533 bytes ⬆️

Bundle name	Size	Change
sentry-docs-server	7.42MB	540 bytes ⬆️
sentry-docs-edge-server	461.49kB	3 bytes ⬇️
sentry-docs-client	6.18MB	4 bytes ⬇️

ryan953 · 2024-05-14T00:18:19Z

docs/platforms/javascript/common/user-feedback/v7/index.mdx

+## User Feedback Widget
+
+The User Feedback Widget offers many customization options, and if the available options are insufficient, you can [use your own UI](#bring-your-own-widget). The following image shows which elements are customizable. The configuration keys on the left side of the image correspond to [text customization](#text-customization) and the configuration keys on the right side of the image are for [theme customizations](#theme-customization).


todo: we should mention that this version is deprecated (was beta, and v8 is the GA) and migration docs are available at https://github.com/getsentry/sentry-javascript/blob/develop/docs/migration/feedback.md

lizokm

Thanks for adding this! I just have some small language suggestions.

lizokm · 2024-05-17T21:57:00Z

docs/platforms/javascript/common/user-feedback/configuration/index.mdx

 #### User Context

-If you have set a user context by calling [`Sentry.setUser`](/platforms/javascript/enriching-events/identify-user/) then those values will be used as defaults for the `name` and `email` fields. If those fields are hidden from the user, then the default values will still be sent along with the feedback message.
+If you have set a user context by calling <PlatformLink to="/enriching-events/identify-user/">`Sentry.setUser()`</PlatformLink> then those values will be used as defaults for the `name` and `email` fields. If those fields are hidden from the user, then the default values will still be sent along with the feedback message.


Suggested change

If you have set a user context by calling <PlatformLink to="/enriching-events/identify-user/">`Sentry.setUser()`</PlatformLink> then those values will be used as defaults for the `name` and `email` fields. If those fields are hidden from the user, then the default values will still be sent along with the feedback message.

If you've set a user context by calling <PlatformLink to="/enriching-events/identify-user/">`Sentry.setUser()`</PlatformLink>, those values will be used as defaults for the `name` and `email` fields. If those fields are hidden from the user, the default values will still be sent along with the feedback message.

lizokm · 2024-05-17T22:03:24Z

docs/platforms/javascript/common/user-feedback/v7/index.mdx

+---
+title: Beta SDK
+sidebar_order: 6900
+description: "Learn about the general User Feedback configuration fields for version 7 of the JavaScript SDK."


Suggested change

description: "Learn about the general User Feedback configuration fields for version 7 of the JavaScript SDK."

description: "Learn about general User Feedback configuration fields for version 7 of the JavaScript SDK."

lizokm · 2024-05-17T22:05:52Z

docs/platforms/javascript/common/user-feedback/v7/index.mdx

+
+<Alert level="warning" title="Deprecation Warning">
+
+User Feedback in version 7 of the SDK was released as a Beta integration. We recommend using <PlatformLink to="/user-feedback/configuration/">version 8 of the SDK</PlatformLink> instead.


Suggested change

User Feedback in version 7 of the SDK was released as a Beta integration. We recommend using <PlatformLink to="/user-feedback/configuration/">version 8 of the SDK</PlatformLink> instead.

In version 7 of our JavaScript SDK, User Feedback was released as a Beta integration. We recommend updating your SDK to <PlatformLink to="/user-feedback/configuration/">version 8</PlatformLink>.

lizokm · 2024-05-17T22:07:58Z

docs/platforms/javascript/common/user-feedback/v7/index.mdx

+
+## User Feedback Widget
+
+The User Feedback Widget offers many customization options, and if the available options are insufficient, you can [use your own UI](#bring-your-own-widget). The following image shows which elements are customizable. The configuration keys on the left side of the image correspond to [text customization](#text-customization) and the configuration keys on the right side of the image are for [theme customizations](#theme-customization).


Suggested change

The User Feedback Widget offers many customization options, and if the available options are insufficient, you can [use your own UI](#bring-your-own-widget). The following image shows which elements are customizable. The configuration keys on the left side of the image correspond to [text customization](#text-customization) and the configuration keys on the right side of the image are for [theme customizations](#theme-customization).

The User Feedback Widget offers many customization options, and if the available options are insufficient, you can [use your own UI](#bring-your-own-widget). The following image shows which elements are customizable. The configuration keys on the left of the image correspond to [text customization](#text-customization), while the ones on the right side are for [theme customizations](#theme-customization).

lizokm · 2024-05-17T22:09:59Z

docs/platforms/javascript/common/user-feedback/v7/index.mdx

+| `autoInject`   | `boolean`                                  | `true`     | Injects the Feedback widget into the application when the integration is added. Set `autoInject: false` if you want to call `feedback.attachTo()` or `feedback.openDialog()` directly, or only want to show the widget on certain views. |
+| `showBranding` | `boolean`                                  | `true`     | Displays the Sentry logo inside of the form                                                                                                                                                                                              |
+| `colorScheme`  | <code>"system" \| "light" \| "dark"</code> | `"system"` | The color theme to use. `"system"` will follow your OS color scheme.                                                                                                                                                                     |


lizokm · 2024-05-17T23:08:27Z

docs/platforms/javascript/common/user-feedback/v7/index.mdx

+Sometimes it’s important to know when a user started interacting with the feedback form, so you can add custom logging, or start/stop background timers on the page until the user is done.
+


Suggested change

Sometimes it’s important to know when a user started interacting with the feedback form, so you can add custom logging, or start/stop background timers on the page until the user is done.

Because it’s sometimes useful to know when a user started interacting with the feedback form, we've made it possible for you to add custom logging, or start and stop background timers on the page that tell you when the user is done.

lizokm · 2024-05-17T23:16:23Z

docs/platforms/javascript/common/user-feedback/v7/index.mdx

+You can skip the default injected button and use your own button to trigger displaying the form. Call `feedback.attachTo()` to have the SDK attach a click listener to your own button. You can additionally supply the same customization options that the constructor accepts (like for text labels and colors).
+


Suggested change

You can skip the default injected button and use your own button to trigger displaying the form. Call `feedback.attachTo()` to have the SDK attach a click listener to your own button. You can additionally supply the same customization options that the constructor accepts (like for text labels and colors).

You can use your own button instead of the default injected button to trigger the form being displayed, by calling `feedback.attachTo()` to have the SDK attach a click listener to your button. You can also supply the same customization options that the constructor accepts (for example, for text labels and colors).

lizokm · 2024-05-17T23:18:49Z

docs/platforms/javascript/common/user-feedback/v7/index.mdx

+- a JavaScript object with a required `message` property and additionally, optional `name` and `email` properties or a `FormData` instance with the same properties
+- an optional "options" object


Suggested change

- a JavaScript object with a required `message` property and additionally, optional `name` and `email` properties or a `FormData` instance with the same properties

- an optional "options" object

- A JavaScript object with a required `message` property and also optional `name` and `email` properties, or a `FormData` instance with the same properties.

- An optional "options" object.

lizokm · 2024-05-17T23:19:11Z

docs/platforms/javascript/common/user-feedback/v7/index.mdx

+);
+```
+
+Here is a simple example:


Suggested change

Here is a simple example:

Here's a simple example:

lizokm · 2024-05-17T23:23:40Z

docs/platforms/javascript/common/user-feedback/v7/index.mdx

+| ---------------- | ------------------------------------------------------------------------------------------------- |
+| `eventId`        | Manually set the id of the event.                                                                 |
+| `dsn`            | Manually set dsn to report to.                                                                    |
+| `user`           | Manually set user data _[an object with keys listed below]_.                                      |
+| `user.email`     | User's email address.                                                                             |
+| `user.name`      | User's name.                                                                                      |
+| `lang`           | _[automatic]_ – **override for Sentry’s language code**                                           |
+| `title`          | It looks like we’re having issues.                                                                |
+| `subtitle`       | Our team has been notified.                                                                       |
+| `subtitle2`      | If you’d like to help, tell us what happened below. – **not visible on small screen resolutions** |
+| `labelName`      | Name                                                                                              |
+| `labelEmail`     | Email                                                                                             |
+| `labelComments`  | What happened?                                                                                    |
+| `labelClose`     | Close                                                                                             |
+| `labelSubmit`    | Submit                                                                                            |
+| `errorGeneric`   | An unknown error occurred while submitting your report. Please try again.                         |
+| `errorFormEntry` | Some fields were invalid. Please correct the errors and try again.                                |
+| `successMessage` | Your feedback has been sent. Thank you!                                                           |
+| `onLoad`         | n/a - **an optional callback that will be invoked when the widget opens**                         |
+| `onClose`        | n/a - **an optional callback that will be invoked when the widget closes**                        |
+
+The optional callback `onLoad` will be called when users see the widget. You can use this to run custom logic, for example to log an analytics event:


Suggested change

| ---------------- | ------------------------------------------------------------------------------------------------- |

| `eventId` | Manually set the id of the event. |

| `dsn` | Manually set dsn to report to. |

| `user` | Manually set user data _[an object with keys listed below]_. |

| `user.email` | User's email address. |

| `user.name` | User's name. |

| `lang` | _[automatic]_ – **override for Sentry’s language code** |

| `title` | It looks like we’re having issues. |

| `subtitle` | Our team has been notified. |

| `subtitle2` | If you’d like to help, tell us what happened below. – **not visible on small screen resolutions** |

| `labelName` | Name |

| `labelEmail` | Email |

| `labelComments` | What happened? |

| `labelClose` | Close |

| `labelSubmit` | Submit |

| `errorGeneric` | An unknown error occurred while submitting your report. Please try again. |

| `errorFormEntry` | Some fields were invalid. Please correct the errors and try again. |

| `successMessage` | Your feedback has been sent. Thank you! |

| `onLoad` | n/a - **an optional callback that will be invoked when the widget opens** |

| `onClose` | n/a - **an optional callback that will be invoked when the widget closes** |

The optional callback `onLoad` will be called when users see the widget. You can use this to run custom logic, for example to log an analytics event:

| ---------------- | ------------------------------------------------------------------------------------------------- |

| `eventId` | Manually set the id of the event. |

| `dsn` | Manually set dsn to report to. |

| `user` | Manually set user data _[an object with keys listed below]_. |

| `user.email` | User's email address. |

| `user.name` | User's name. |

| `lang` | _[automatic]_ – (**Override for Sentry’s language code.**) |

| `title` | It looks like we’re having issues. |

| `subtitle` | Our team has been notified. |

| `subtitle2` | If you’d like to help, tell us what happened below. – (**Not visible on small screen resolutions.**) |

| `labelName` | Name |

| `labelEmail` | Email |

| `labelComments` | What happened? |

| `labelClose` | Close |

| `labelSubmit` | Submit |

| `errorGeneric` | An unknown error occurred while submitting your report. Please try again. |

| `errorFormEntry` | Some fields were invalid. Please correct the errors and try again. |

| `successMessage` | Your feedback has been sent. Thank you! |

| `onLoad` | n/a - (**An optional callback that will be invoked when the widget opens.**) |

| `onClose` | n/a - (**An optional callback that will be invoked when the widget closes.**) |

The optional callback `onLoad` will be called when users see the widget. You can use this to run custom logic, for example to log an analytics event:

ryan953 · 2024-05-20T18:17:36Z

@lizokm I applied all your code suggestions manually, and put them into both the v7 and v8 config pages because there's a bunch of copy+paste between them.
Now that I'm seeing all the copy+paste i'm thinking about using more <PlatformContent> sections to fix that up, but i think that'll be a good followup PR instead now

docs(feedback): Keep SDK v7 config docs

77c8e6a

ryan953 marked this pull request as draft May 13, 2024 23:33

ryan953 added a commit that referenced this pull request May 13, 2024

remove v7 docs, they are in #10009

a477dca

vercel bot deployed to Preview May 13, 2024 23:50 View deployment

ryan953 commented May 14, 2024

View reviewed changes

fix links and update v7 feedback config page title

bcf2efd

ryan953 marked this pull request as ready for review May 17, 2024 20:09

Merge branch 'master' into ryan953/feedback-v7-config

d6c3a7d

ryan953 requested review from a team, vivianyentran and lizokm May 17, 2024 20:10

vercel bot deployed to Preview May 17, 2024 20:45 View deployment

lizokm approved these changes May 17, 2024

View reviewed changes

apply review comments to v7 and v8 docs

8dcd0bc

vercel bot deployed to Preview May 20, 2024 18:32 View deployment

ryan953 merged commit 2c62e17 into master May 20, 2024
6 checks passed

ryan953 deleted the ryan953/feedback-v7-config branch May 20, 2024 19:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs(feedback): Keep SDK v7 config docs #10009

docs(feedback): Keep SDK v7 config docs #10009

ryan953 commented May 13, 2024 •

edited

vercel bot commented May 13, 2024 •

edited

codecov bot commented May 13, 2024 •

edited

ryan953 May 14, 2024

lizokm left a comment

lizokm May 17, 2024

lizokm May 17, 2024

lizokm May 17, 2024

lizokm May 17, 2024

lizokm May 17, 2024

lizokm May 17, 2024

lizokm May 17, 2024

lizokm May 17, 2024

lizokm May 17, 2024

lizokm May 17, 2024

ryan953 commented May 20, 2024

		## User Feedback Widget

		The User Feedback Widget offers many customization options, and if the available options are insufficient, you can [use your own UI](#bring-your-own-widget). The following image shows which elements are customizable. The configuration keys on the left side of the image correspond to [text customization](#text-customization) and the configuration keys on the right side of the image are for [theme customizations](#theme-customization).

	If you have set a user context by calling <PlatformLink to="/enriching-events/identify-user/">`Sentry.setUser()`</PlatformLink> then those values will be used as defaults for the `name` and `email` fields. If those fields are hidden from the user, then the default values will still be sent along with the feedback message.
	If you've set a user context by calling <PlatformLink to="/enriching-events/identify-user/">`Sentry.setUser()`</PlatformLink>, those values will be used as defaults for the `name` and `email` fields. If those fields are hidden from the user, the default values will still be sent along with the feedback message.

	description: "Learn about the general User Feedback configuration fields for version 7 of the JavaScript SDK."
	description: "Learn about general User Feedback configuration fields for version 7 of the JavaScript SDK."


		<Alert level="warning" title="Deprecation Warning">

		User Feedback in version 7 of the SDK was released as a Beta integration. We recommend using <PlatformLink to="/user-feedback/configuration/">version 8 of the SDK</PlatformLink> instead.

	User Feedback in version 7 of the SDK was released as a Beta integration. We recommend using <PlatformLink to="/user-feedback/configuration/">version 8 of the SDK</PlatformLink> instead.
	In version 7 of our JavaScript SDK, User Feedback was released as a Beta integration. We recommend updating your SDK to <PlatformLink to="/user-feedback/configuration/">version 8</PlatformLink>.

		Sometimes it’s important to know when a user started interacting with the feedback form, so you can add custom logging, or start/stop background timers on the page until the user is done.

	Sometimes it’s important to know when a user started interacting with the feedback form, so you can add custom logging, or start/stop background timers on the page until the user is done.
	Because it’s sometimes useful to know when a user started interacting with the feedback form, we've made it possible for you to add custom logging, or start and stop background timers on the page that tell you when the user is done.

		You can skip the default injected button and use your own button to trigger displaying the form. Call `feedback.attachTo()` to have the SDK attach a click listener to your own button. You can additionally supply the same customization options that the constructor accepts (like for text labels and colors).

	You can skip the default injected button and use your own button to trigger displaying the form. Call `feedback.attachTo()` to have the SDK attach a click listener to your own button. You can additionally supply the same customization options that the constructor accepts (like for text labels and colors).
	You can use your own button instead of the default injected button to trigger the form being displayed, by calling `feedback.attachTo()` to have the SDK attach a click listener to your button. You can also supply the same customization options that the constructor accepts (for example, for text labels and colors).

		- a JavaScript object with a required `message` property and additionally, optional `name` and `email` properties or a `FormData` instance with the same properties
		- an optional "options" object

docs(feedback): Keep SDK v7 config docs #10009

docs(feedback): Keep SDK v7 config docs #10009

Conversation

ryan953 commented May 13, 2024 • edited

vercel bot commented May 13, 2024 • edited

codecov bot commented May 13, 2024 • edited

Bundle Report

Choose a reason for hiding this comment

lizokm left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ryan953 commented May 20, 2024

ryan953 commented May 13, 2024 •

edited

vercel bot commented May 13, 2024 •

edited

codecov bot commented May 13, 2024 •

edited