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

[FC-41933] update the mailserver docs to show an example nix configuration #1170

Merged
merged 1 commit into from
Nov 27, 2024

Conversation

PhilTaken
Copy link
Member

@flyingcircusio/release-managers

Internal ticket: FC-41933

Update the documentation for the mailserver role as well as fixing capitalization for Rspamd.

Release process

  • Created changelog entry using ./changelog.sh

PR release workflow (internal)

  • PR has internal ticket
  • internal issue ID (PL-…) part of branch name
  • internal issue ID mentioned in PR description text
  • ticket is on Platform agile board
  • ticket state set to Pull request ready
  • if ticket is more urgent than within the next few days, directly contact a member of the Platform team

Design notes

  • Provide a feature toggle if the change might need to be adjusted/reverted quickly depending on context. Consider whether the default should be on or off. Example: rate limiting.
  • All customer-facing features and (NixOS) options need to be discoverable from documentation. Add or update relevant documentation such that hosted and guided customers can understand it as well.

Security implications

@PhilTaken PhilTaken force-pushed the phil/FC-41933_update-mailserver-docs branch from 2225f40 to 308db30 Compare November 19, 2024 08:43
doc/src/mailserver.md Outdated Show resolved Hide resolved
@PhilTaken PhilTaken force-pushed the phil/FC-41933_update-mailserver-docs branch from 308db30 to c830cf7 Compare November 26, 2024 09:26
doc/src/mailserver.md Outdated Show resolved Hide resolved
@osnyx osnyx force-pushed the phil/FC-41933_update-mailserver-docs branch from 8e5c720 to 0824b5e Compare November 27, 2024 17:29
Copy link
Member

@osnyx osnyx left a comment

Choose a reason for hiding this comment

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

I'd like to get confirmation on whether we intend to deprecate json config for maps. Still merging this for now, as existing json config is not broken by just changing the docs.

@zagy @PhilTaken

@osnyx osnyx force-pushed the phil/FC-41933_update-mailserver-docs branch from 0824b5e to 37bdb7f Compare November 27, 2024 18:31
@osnyx
Copy link
Member

osnyx commented Nov 27, 2024

rebased onto fc-24.05-dev, hoping this fixes the gitlab test.

@osnyx osnyx merged commit 34f36af into fc-24.05-dev Nov 27, 2024
2 checks passed
@osnyx osnyx deleted the phil/FC-41933_update-mailserver-docs branch November 27, 2024 21:47
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.

3 participants