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

ref(replay): Update Replay installation with SDK-package import #5971

Merged
merged 3 commits into from
Dec 20, 2022

Conversation

Lms24
Copy link
Member

@Lms24 Lms24 commented Dec 16, 2022

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/replay anymore, as it is now a dependency of @sentry/browser which exports the Replay integration.

  • Update the session replay setup page
  • Update the session replay onboarding wizard

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

@Lms24 Lms24 requested a review from a team as a code owner December 16, 2022 14:17
@vercel
Copy link

vercel bot commented Dec 16, 2022

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

Name Status Preview Updated
sentry-docs ✅ Ready (Inspect) Visit Preview Dec 20, 2022 at 11:00AM (UTC)

@Lms24 Lms24 requested review from ryan953, billyvg and jas-kas December 16, 2022 14:18
@@ -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:
Copy link
Member Author

@Lms24 Lms24 Dec 16, 2022

Choose a reason for hiding this comment

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

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";
Copy link
Member Author

@Lms24 Lms24 Dec 16, 2022

Choose a reason for hiding this comment

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

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.

@Lms24 Lms24 changed the title ref(replay): Update Replay installation docs after SDK 7.27.0 release ref(replay): Update Replay installation with SDK-package import Dec 16, 2022
@Lms24 Lms24 self-assigned this Dec 19, 2022
Lms24 and others added 2 commits December 20, 2022 11:46
Co-authored-by: Jasmin <77064737+jas-kas@users.noreply.github.com>
@Lms24 Lms24 merged commit 50fe3db into master Dec 20, 2022
@Lms24 Lms24 deleted the lms-replay-browser-export branch December 20, 2022 10:53
@github-actions github-actions bot locked and limited conversation to collaborators Jan 5, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants