Repository navigation
docs: add the 3.0 to 3.1 upgrade guide - #148
Merged
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
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.
Closes #146. Documents the breaking changes of 3.1.0, as listed in the framework changelog (quantum-php/framework#609).
What changed
v3.0/upgrade-guide.mdbecomes a two-part guide: "Upgrading from 3.0 to 3.1", new and first, and "Upgrading from 2.x to 3.0", unchanged except that its headings go down one level so they nest under the part title. Each 3.1 section says what to change, with before and after code where code changes, or that no action is needed, and links to the package page that explains the topic:psr/log2 or 3, theLoggermessage type, theResponseHeadersandDatabaseHandlerreturn typesdoctrine/annotationsis no longer requiredHookis replaced byEventQuantum\Loaderis removed, andSetupmoved toQuantum\Config\Setupgrepfor the replaced namesEvery example was checked against the framework code on
masterand against 3.0.3.Changed paths
v3.0/upgrade-guide.mdSUMMARY.md: the entry is renamed from "Upgrade Guide (2.x to 3.0)" to "Upgrade Guide"Notes for reviewers
@OAnote incli/code-generation.mdcan shrink to a link to section 2 of the guide.