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.

Sign up for GitHub

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

Jump to bottom

Configuration Reference #38

Open
Mischback opened this issue Nov 21, 2022 · 0 comments
Open

Configuration Reference #38

Mischback opened this issue Nov 21, 2022 · 0 comments
Labels
area/documentation Affects the documentation service/dovecot Affects Dovecot or its configurations service/postfix Affects Postfix or its configurations type/improvement Improvement of an existing feature
Milestone
Fly

Comments

@Mischback
Copy link
Owner

While working on the configuration reference (as tracked in #23) it feels like duplicating too much.

configs/postfix/main.cf does already include lots of documentation, it feels unnecessary to duplicate this again for the Sphinx-based documentation.

Instead, let's parse the actual configuration files, extract the comments and generate the Sphinx documentation automatically.

For reference: 9f08744 has rST compatible documentation of some Postfix settings.
@Mischback Mischback added area/documentation Affects the documentation type/improvement Improvement of an existing feature service/postfix Affects Postfix or its configurations service/dovecot Affects Dovecot or its configurations labels Nov 21, 2022
@Mischback Mischback added this to the Fly milestone Nov 21, 2022
Mischback added a commit that referenced this issue Nov 21, 2022
@Mischback
Modify Postfix's configuration reference
a36f863 
See #38 for details and the reasoning behind removing the existing
documentation.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area/documentation Affects the documentation service/dovecot Affects Dovecot or its configurations service/postfix Affects Postfix or its configurations type/improvement Improvement of an existing feature
Projects
None yet
Milestone
Fly
Development

No branches or pull requests
1 participant
@Mischback