docs(feedback): Add migration docs for moving from feedbackIntegration 7.x to 8.0.0 #11731
+163
−2
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ryan953
changed the title
…n v7.x to v8.0.0-beta.2
ryan953
force-pushed
the
ryan953/feedback-migration-docs
branch
from
c4562f1
to
99250b4
Compare
ryan953
changed the title
c298lee
reviewed
May 9, 2024
| @@ -0,0 +1,148 @@ | |||
| # End of Feedback Beta | |||
|
|
|||
| With the release of 8.0.0 Sentry Feedback is now out of Beta. This means that the usual stabilty guarantees apply. | |||
There was a problem hiding this comment.
Suggested change
| With the release of 8.0.0 Sentry Feedback is now out of Beta. This means that the usual stabilty guarantees apply. | |
| With the release of 8.0.0, Sentry Feedback is now out of Beta. This means that the usual stabilty guarantees apply. |
c298lee
reviewed
May 9, 2024
| Feedback 8.0.0 requires server version 24.4.2 and above. | ||
|
|
||
| Because of experimentation and rapid iteration, during the Beta period some bugs and problems came up which have since | ||
| been fixed/improved, as well as API's which have been streamlined and chanaged. |
There was a problem hiding this comment.
Suggested change
| been fixed/improved, as well as API's which have been streamlined and chanaged. | |
| been fixed/improved, as well as API's which have been streamlined and changed. |
c298lee
reviewed
May 9, 2024
|
|
||
| | Method Name | Replacement | Notes | | ||
| | ------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | `feedback.getWidget()` | `const widget = feedback.createWidget(); widget.appendToDom()` | The SDK no longer maintains a stack of form instances. If you call `createWidget()` a new widget will be inserted into the DOM and a `ActorComponent` returned allowed you control over the lifecycle of the widget. | |
There was a problem hiding this comment.
Suggested change
| | `feedback.getWidget()` | `const widget = feedback.createWidget(); widget.appendToDom()` | The SDK no longer maintains a stack of form instances. If you call `createWidget()` a new widget will be inserted into the DOM and a `ActorComponent` returned allowed you control over the lifecycle of the widget. | | |
| | `feedback.getWidget()` | `const widget = feedback.createWidget(); widget.appendToDom()` | The SDK no longer maintains a stack of form instances. If you call `createWidget()` a new widget will be inserted into the DOM and an `ActorComponent` returned allows you control over the lifecycle of the widget. | |
c298lee
reviewed
May 9, 2024
| | ------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | `feedback.getWidget()` | `const widget = feedback.createWidget(); widget.appendToDom()` | The SDK no longer maintains a stack of form instances. If you call `createWidget()` a new widget will be inserted into the DOM and a `ActorComponent` returned allowed you control over the lifecycle of the widget. | | ||
| | - | `const form = await feedback.createForm()` | A new method `createForm()`, used internally by `createWidget()` and `attachTo()`, returns a `Promise<FeedbackDialog>` so you can control showing and hiding of the feedback form directly. | | ||
| | `feedback.attachTo()` | `const unsubscribe = feedback.attachTo(myButtonElem)` | The `attachTo()` method in will create an onClick event listener to your html element that calls appendToDom() and open(). It returns a callback to remove the event listener. | |
There was a problem hiding this comment.
Suggested change
| | `feedback.attachTo()` | `const unsubscribe = feedback.attachTo(myButtonElem)` | The `attachTo()` method in will create an onClick event listener to your html element that calls appendToDom() and open(). It returns a callback to remove the event listener. | | |
| | `feedback.attachTo()` | `const unsubscribe = feedback.attachTo(myButtonElem)` | The `attachTo()` method will create an onClick event listener to your html element that calls `appendToDom()` and `open()`. It returns a callback to remove the event listener. | |
c298lee
reviewed
May 9, 2024
| } | ||
| ``` | ||
|
|
||
| Alternativly you can call `createForm()` and control the form directly: |
There was a problem hiding this comment.
Suggested change
| Alternativly you can call `createForm()` and control the form directly: | |
| Alternatively you can call `createForm()` and control the form directly: |
billyvg
reviewed
May 9, 2024
Comment on lines
+61
to
+62
| // Option 2: Get a reference from the SDK client | ||
| const feedbackInstance = getClient()?.getIntegrationByName('Feedback'); |
There was a problem hiding this comment.
We have getFeedback() now don't we?
| | Old Name | New Name | Default Value | | ||
| | ------------- | ----------------------- | ------------------------------ | | ||
| | `buttonLabel` | `triggerLabel` | `"Report a bug"` | | ||
| | - | `isRequiredLabel` | `"(required)"` | |
There was a problem hiding this comment.
Suggested change
| | - | `isRequiredLabel` | `"(required)"` | | |
| | `isRequiredText` | `isRequiredLabel` | `"(required)"` | |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As the User Feedback feature moves from alpha/beta to GA some changes to the public API have been made, and version requirements for the server (for on-prem users) are being solidified.
Related to getsentry/develop#1206