docs: add migrations page, rewrite deprecations #5433
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
gravyboat
reviewed
Jul 12, 2023
9271457 to
6dd2355
Compare
6dd2355 to
46d3a86
Compare
gravyboat
approved these changes
Jul 13, 2023
Member
gravyboat
left a comment
There was a problem hiding this comment.
I'll mark this as approved and you can merge whenever you're ready. I don't see anything else worth mentioning.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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 properly separates deprecations from breaking changes + migration hints. The deprecations page previously was a mixture of both without a clear distinction.
Breaking changes without any deprecations or migrations won't be included on the migrations page. That's what the changelog is for.
I've also changed the section headlines according to the page they are on, added hints when a deprecation got removed, and also added links to the issue/PR which introduced a deprecation or which argued for the change, as well as the PR which applied the breaking change.
Technically, the migration hints from the
Plugin.can_handle_url()/Plugin.priority()changes should be moved to the migrations page. I left untouched it for now.See the rendered docs preview. There's a high chance I messed something up here. I'll have a deeper look at this again later today.
With the addion of the migrations page, this adds proper documentation for the breaking changes of 6.0.0: