Skip to content

docs(v8): Restructure migration docs #10830

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

Merged
merged 3 commits into from
Feb 29, 2024
Merged

Conversation

AbhiPrasad
Copy link
Member

This is an attempt to restructure our migration docs in preparation for the first alpha.

@AbhiPrasad AbhiPrasad requested a review from a team February 27, 2024 19:49
@AbhiPrasad AbhiPrasad self-assigned this Feb 27, 2024
@AbhiPrasad AbhiPrasad requested review from stephanie-anderson and s1gr1d and removed request for a team February 27, 2024 19:49
@AbhiPrasad AbhiPrasad force-pushed the abhi-migration-docs-v8 branch 2 times, most recently from 8fae36f to 3b7af66 Compare February 27, 2024 19:52
MIGRATION.md Outdated
`['localhost', /^\/(?!\/)/]`. This meant that all request targets to that had "localhost" in the URL, or started with a
`/` were equipped with tracing headers. This default was chosen to prevent CORS errors in your browser applications.
However, this default had a few flaws.
**Node.js**: We now official support Node 14+ for our CJS package, and Node 18.8+ for our ESM package. This applies to
Copy link
Member

Choose a reason for hiding this comment

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

Actually let's make this 14.8+ as this is what supports async local storage! (I'll also bump the actual engines for this)

MIGRATION.md Outdated

## Removal of the `tracingOrigins` option
For IE11 support please transpile your code to ES% using babel or similar and add required polyfills.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
For IE11 support please transpile your code to ES% using babel or similar and add required polyfills.
For IE11 support please transpile your code to ES5 using babel or similar and add required polyfills.


`@sentry/hub` has been removed. All exports from `@sentry/tracing` should be available in `@sentry/core` or in
`@sentry/browser` and `@sentry/node`.
Sentry.addTracingExtensions();
Copy link
Member

Choose a reason for hiding this comment

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

do we need this if we add browser tracing below?

Copy link
Member Author

Choose a reason for hiding this comment

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

copy paste error - fixed!

Copy link
Member

@mydea mydea left a comment

Choose a reason for hiding this comment

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

mostly skimmed this for now, will do a more in-depth read later, but it's for sure an improvement, so let's :shipit:

Copy link
Member

@Lms24 Lms24 left a comment

Choose a reason for hiding this comment

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

Great improvement! Also thx for splitting up the various version migrations into their own files!

I think for a stable version we should more clearly outline which changes apply to all SDKs vs. to specific SDKs. Maybe what would help here in general is some kind of index/table of content on the top because this migration guide is just so damn long 😅

(Alternatively a "How to read this guide" section where we explain what users should read)

MIGRATION.md Outdated

## Removal of `Sentry.configureScope` (#10565)
```js
// Before
Copy link
Member

Choose a reason for hiding this comment

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

super-l: doesn't have to happen now but for clarity, we could label the changes as v7/v8 vs. before/after?

Copy link
Member Author

Choose a reason for hiding this comment

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

yes good idea!

MIGRATION.md Outdated
integrations: [Sentry.browserTracingIntegration()],
});

// You still need to add the Trace Service like before!
Copy link
Member

Choose a reason for hiding this comment

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

l:

Suggested change
// You still need to add the Trace Service like before!
// You still need to add the TraceService like before!

@AbhiPrasad AbhiPrasad force-pushed the abhi-migration-docs-v8 branch from 3b7af66 to f2c6378 Compare February 29, 2024 15:15
@AbhiPrasad AbhiPrasad enabled auto-merge (squash) February 29, 2024 15:15
@AbhiPrasad AbhiPrasad merged commit 95d2982 into develop Feb 29, 2024
@AbhiPrasad AbhiPrasad deleted the abhi-migration-docs-v8 branch February 29, 2024 15:29
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.

3 participants