ref(replay): Update Replay installation with SDK-package import#5971
Merged
ref(replay): Update Replay installation with SDK-package import#5971
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Lms24
commented
Dec 16, 2022
| @@ -1,13 +1,13 @@ | |||
| Install the Replay package with the package manager of your choice. Alternatively, you can load the Replay integration using a CDN bundle: | |||
| The Replay Integration is **already included** in your Browser or Framework SDK NPM packages. If you're using CDN bundles instead of NPM packages, you need to load the Replay integration CDN bundle in addition to your browser bundle: | |||
Member
Author
There was a problem hiding this comment.
I made some changes to the text. Not sure if this is the best wording, so feel free to suggest alternatives.
| @@ -4,8 +4,6 @@ To set up the integration, add the following to your Sentry initialization. Seve | |||
| // import Sentry from your framework SDK (e.g. @sentry/react) instead of @sentry/browser | |||
| import * as Sentry from "@sentry/browser"; | |||
Member
Author
There was a problem hiding this comment.
We should make this platform-specific some time in the future (just like in the wizard), to show the correct package import for each framework.
jas-kas
reviewed
Dec 16, 2022
jas-kas
reviewed
Dec 16, 2022
jas-kas
approved these changes
Dec 16, 2022
billyvg
approved these changes
Dec 16, 2022
Co-authored-by: Jasmin <77064737+jas-kas@users.noreply.github.com>
This file contains hidden or 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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 participants
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.
This PR updates the Session Replay docs after we released version 7.27.0 of the JS SDKs. With this new version, users don't need to explicitly install
@sentry/replayanymore, as it is now a dependency of@sentry/browserwhich exports the Replay integration.ref #getsentry/sentry-javascript#6326
Note: I'd like to keep this PR open for a few days (Monday or so) just to make sure 7.27.0 isn't breaking anything