-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
meta(v9): Add v9 migration guide #14296
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
Conversation
@@ -0,0 +1,159 @@ | |||
# Upgrading from 8.x to 9.x |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You might ask yourself what is this file doing here.
Well, I started off this PR with actually doing the full changes for v9, leading me to move the v8 migration guide into its separate file. This is actually quite a bit of work with changing the links and all that stuff.
For this reason I would actually keep this file here for when we do the official switch because I don't wanna throw away that work.
docs/migration/v7-to-v8.md
Outdated
@@ -0,0 +1,1955 @@ | |||
# Upgrading from 7.x to 8.x |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Given this is a duplicate of what's in MIGRATION.md
, shall we avoid having this here for now? We can add it later when we formally make the switch.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
sure
**DISCLAIMER: THIS MIGRATION GUIDE IS WORK IN PROGRESS** | ||
|
||
Version 9 of the Sentry SDK concerns itself with API cleanup and compatibility updates. | ||
This update contains behavioral changes that will not be caught by TypeScript or linters, so we recommend carefully reading the section on [Behavioral Changes](#2-behavior-changes). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
meta: I just realized that our comments/docs are a mix of american and british english (for ex: behavioral vs. behavioural) because of me. I made it Behaviour in the v8 migration docs.
We should probably mandate american english spelling to match the docs (even though colour
is vastly superior to color
in every way).
Ref #14289
This PR adds a migration guide for v9 we can iterate on. It is not the final migration guide.
We are keeping the v8 migration guide as the main one for now until v9 is released.
In future PRs we will