docs: list configuration changes in the 1.x to 2.x migration guide - #3513
Draft
pjfanning wants to merge 1 commit into
Draft
docs: list configuration changes in the 1.x to 2.x migration guide#3513pjfanning wants to merge 1 commit into
pjfanning wants to merge 1 commit into
Conversation
Motivation: The 1.x to 2.x migration guide did not mention the reference.conf changes between the 1.7.x and main branches, so users had no single place to review new settings and changed defaults. Modification: Add a Configuration Changes section to migration-guide-1.x-2.x.md covering changed default values, removed settings and new settings, grouped by module, with links to the originating PRs and to the default configuration reference. Result: Users migrating from Pekko 1.x to 2.x can review the configuration changes in one place. Tests: - Not run - docs only References: None - sourced from diffing reference.conf files between 1.7.x and main
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
1 participant
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.
Motivation
The 1.x to 2.x migration guide did not mention the
reference.confchanges between the 1.7.x and main branches, so users had no single place to review new settings and changed defaults when upgrading.Modification
Add a "Configuration Changes in Pekko 2.x" section to
migration-guide-1.x-2.x.md, based on diffing allsrc/main/resources/reference.conffiles between the1.7.xandmainbranches. It covers:minimum-runnable,propagate-harmless-quarantine-events,tcp-magic, the Artery frequency sketch, persistence plugin dispatchers)@reflinks to the default configuration reference and links to the PRs that introduced each settingResult
Users migrating from Pekko 1.x to 2.x can review the configuration changes in one place.
Tests
References
None - sourced from diffing the
reference.conffiles between the1.7.xandmainbranches