Documentation for aliases
- Dominant language
- Go
- Stars
- 6.1k
- Forks
- 327
- PR merge metrics
- No merged PRs in 30d
Description
# Describe the bug
Missing documentation of `/etc/maddy/aliases`.
# Steps to reproduce
I followed the tutorial to setup a simple personal mail server. It was easy and straightforward. Just the needed mail aliases took a long time to setup, because it was not documented and a search brought me at first to some complex setup descriptions. Eventually I found a mention of the aliases file in some PR or commit message.
# Log files
n/a
# Configuration file
n/a
# Environment information
* maddy version: 0.7.1
A sentence about `/etc/maddy/aliases` at the end of the tutorial and/or an example file for e.g. an alias hostmaster would be nice for newcomers.
Contributor guide
Research direction
Start with the tutorial and the existing documentation around mail aliases; the issue specifically identifies /etc/maddy/aliases and suggests an alias-hostmaster example. Done means documenting the aliases file with a short tutorial note and/or example configuration so newcomers can set up aliases without searching elsewhere.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100