streamline migration guide wording, provide titled steps #789
+68
−42
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
hpk42
temporarily deployed
to
staging.chatmail.at/doc/relay/
GitHub Actions
Inactive
hpk42
had a problem deploying
to
staging-ipv4.testrun.org
GitHub Actions
Error
hpk42
had a problem deploying
to
staging2.testrun.org
GitHub Actions
Error
… "set TTL to 5 minute" phrasing a bit.
hpk42
force-pushed
the
hpk/migration-docs2
branch
from
91817ee to
fe5baf0
Compare
hpk42
temporarily deployed
to
staging.chatmail.at/doc/relay/
GitHub Actions
Inactive
hpk42
had a problem deploying
to
staging-ipv4.testrun.org
GitHub Actions
Error
hpk42
had a problem deploying
to
staging2.testrun.org
GitHub Actions
Error
… clarity and focus
hpk42
force-pushed
the
hpk/migration-docs2
branch
from
fe5baf0 to
6f2ae42
Compare
hpk42
temporarily deployed
to
staging.chatmail.at/doc/relay/
GitHub Actions
Inactive
hpk42
temporarily deployed
to
staging2.testrun.org
GitHub Actions
Inactive
adbenitez
approved these changes
Dec 19, 2025
adbenitez
reviewed
Dec 19, 2025
hpk42
temporarily deployed
to
staging2.testrun.org
GitHub Actions
Inactive
hpk42
temporarily deployed
to
staging-ipv4.testrun.org
GitHub Actions
Inactive
missytake
approved these changes
Dec 21, 2025
Contributor
missytake
left a comment
missytake
left a comment
There was a problem hiding this comment.
Looks good :) being short is not a priority here I think, rather that it is also understandable by inexperienced sysadmins. But the bold headlines help a lot already, and https://staging.chatmail.at/doc/relay/789/migrate.html looks great.
I wonder whether it should be more clear, which commands are run on the laptop (all that don't start with an ssh) Maybe it's fine.
| 2. **Pre-configure the new site but keep it inactive until step 6** | ||
| :: | ||
|
|
||
| CMDEPLOY_STAGES=install,configure cmdeploy run --ssh-host $NEW_IP4 |
Contributor
There was a problem hiding this comment.
Suggested change
| CMDEPLOY_STAGES=install,configure cmdeploy run --ssh-host $NEW_IP4 | |
| CMDEPLOY_STAGES=install,configure scripts/cmdeploy run --ssh-host $NEW_IP4 |
This would give a slightly less confusing error essage I think :)
|
|
||
| :: | ||
|
|
||
| CMDEPLOY_STAGES=activate cmdeploy run --ssh-host $NEW_IP4 |
Contributor
There was a problem hiding this comment.
Suggested change
| CMDEPLOY_STAGES=activate cmdeploy run --ssh-host $NEW_IP4 | |
| CMDEPLOY_STAGES=activate scripts/cmdeploy run --ssh-host $NEW_IP4 |
same here
| :: | ||
|
|
||
| cmdeploy run --disable-mail --ssh-host 13.12.23.42 | ||
| cmdeploy run --disable-mail --ssh-host $OLD_IP4 |
Contributor
There was a problem hiding this comment.
Suggested change
| cmdeploy run --disable-mail --ssh-host $OLD_IP4 | |
| scripts/cmdeploy run --disable-mail --ssh-host $OLD_IP4 |
and here.
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 started from #780 but grew into a larger refactoring. It tries to be very short, and provide titles
to the various steps, so it's clearer what happens. Also, operators might be executing the steps while being in an emergency (discs failing).
closes #780