Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Various README improvements #531

Merged
merged 4 commits into from
Mar 26, 2025
Merged

Various README improvements #531

merged 4 commits into from
Mar 26, 2025

Conversation

feld
Copy link
Collaborator

@feld feld commented Mar 24, 2025

  • chatmail -> Chatmail
  • e-mail -> email
  • capitalization of software and protocols (Postfix, Dovecot, SMTP, etc)

Rephrased the install instructions to start by recommending the DNS records that cmdeploy is going to check for immediately anyway.

Refactored the migration guide to fix incorrect tar commands (wrong usage of -C flag) and suggest how to copy directly from server to server by logging in with SSH agent forwarding. The mail services should be disabled first before proceeding with any changes and also ensure the echobot and mail spool are copied over to the new server so no messages are lost.

Copy link
Contributor

@hpk42 hpk42 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

overall good, thanks! apart from review comments: i am dubious about capitalizing chatmail. At least i wouldn't mix in it here, but rather discuss it generally and then do changes across several files in one dedicated PR.

@feld feld force-pushed the readme-improvements branch from e1d3ffa to 4657a05 Compare March 25, 2025 21:25
feld and others added 4 commits March 25, 2025 14:32
- e-mail -> email
- capitalization of software and protocols (Postfix, Dovecot, SMTP, etc)

Rephrased the install instructions to start by recommending the DNS records that cmdeploy is going to check for immediately anyway.

Refactored the migration guide to fix incorrect tar commands (wrong usage of -C flag) and suggest how to copy directly from server to server by logging in with SSH agent forwarding. The mail services should be disabled first before proceeding with any changes and also ensure the echobot and mail spool are copied over to the new server so no messages are lost.
Co-authored-by: holger krekel  <[email protected]>
Co-authored-by: holger krekel  <[email protected]>
@feld feld force-pushed the readme-improvements branch from 0da33bd to 365757d Compare March 25, 2025 21:32
@feld
Copy link
Collaborator Author

feld commented Mar 25, 2025

I think all of the discussed changes have been integrated. Please check the diffs and give another review.

Copy link
Contributor

@hpk42 hpk42 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok, thanks! we typically write "e-mail" instead of email but i'll approve and merge anyway to not drag this review/merge too long.

One thing that maybe @missytake can verify is if the "migration" guide is still fitting (the previous one was manually tested).

@hpk42 hpk42 merged commit 724020e into chatmail:main Mar 26, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants