docs(migration): Add TLDR to v7 migration docs #5041
Merged
Conversation
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
lforst
requested review from
Lms24,
AbhiPrasad,
lobsterkatie and
HazAT
and removed request for
Lms24 and
AbhiPrasad
size-limit report 📦
|
Lms24
approved these changes
May 5, 2022
MIGRATION.md
Outdated
| @@ -3,6 +3,13 @@ | |||
| The main goal of version 7 is to reduce bundle size. This version is breaking because we removed deprecated APIs, upgraded our build tooling, and restructured npm package contents. | |||
| Below we will outline all the breaking changes you should consider when upgrading. | |||
|
|
|||
| TL;DR if you copy & pasted the basic examples from our docs: | |||
There was a problem hiding this comment.
Suggested change
| TL;DR if you copy & pasted the basic examples from our docs: | |
| TL;DR: If you just use basic features of Sentry (e.g. you copy & pasted the basic examples from our docs), here's what changed for you: |
There was a problem hiding this comment.
Totally optional but maybe something along those lines to make the intent of the TL;DR a bit clearer. WDYT?
There was a problem hiding this comment.
Slightly adjusted because i didn't like the parenthesis. Let me know what you think of it now!
There was a problem hiding this comment.
Nice, I like it. Thanks for taking another look!
Lms24
approved these changes
May 5, 2022
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.
Adds a tldr section at the top of the v7 migration docs for users who only have a basic installation of sentry without any advanced features.
Thought process being: "If people copy & pasted examples from our docs in the past, what do they need to do so it still works after upgrading to v7?"
Ref: https://getsentry.atlassian.net/browse/WEB-904