Add clarifying paragraph to One-Step Migration #918
Conversation
This file contains 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
rgugliel-da
reviewed
Feb 20, 2025
| @@ -796,8 +796,8 @@ these prior releases to a protocol version supported by this minor release versi | |||
| tests, and its steps are known to work, additional measures and configuration may be required to | |||
| address the peculiarities of your environment. | |||
|
|
|||
| One-Step Migration Recipe for 2.10 | |||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |||
| Migration Recipe for 2.10 | |||
There was a problem hiding this comment.
I am unsure about this change:
- Text above (line 777) stills mentions "One-step", so we should be consistent.
- Also, this precision is important. We usually have two kind of migrations: replacing the binary and doing an hard domain migration. The "one-step" here implies that we are doing both at the same time, which is relevant information. Maybe we could rephrase but I am unsure that dropping completely is good.
There was a problem hiding this comment.
Thanks for the clarification! 🤔
There was a problem hiding this comment.
@rgugliel-da, I have reverted the change to the heading and added a very explicit definition of "one-step migration." This might help avoid the confusion that Michelle and I had on the topic.
Does this look ok?
wallacekelly-da
changed the title
rgugliel-da
approved these changes
Feb 20, 2025
carrielaben-da
approved these changes
Feb 21, 2025
Co-authored-by: carrielaben-da <[email protected]>
Co-authored-by: carrielaben-da <[email protected]>
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.
This PR changes the heading "One-Step Migration Recipe for 2.10" to simply "Migration Recipe for 2.10".EDIT: This PR adds a new short paragraph to more explicitly define the term "one-step migration."The original intent of the heading was probably based on the idea of a single migration step from any 2.3+ directly to 2.10, instead of having to go through each intermediate major release version.Edit: this is wrong, as discussed in the comments.However, the text itself uses "steps" to enumerate the steps of the recipe. The reader may not understand what was meant by the current heading.