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

[TODO]: Replace mailserver.env in favor of improved ENV docs #3791

Open
polarathene opened this issue Jan 17, 2024 · 0 comments
Open

[TODO]: Replace mailserver.env in favor of improved ENV docs #3791

polarathene opened this issue Jan 17, 2024 · 0 comments
Assignees
Labels
area/configuration (file) area/documentation kind/improvement Improve an existing feature, configuration file or the documentation meta/help wanted The OP requests help from others - chime in! :D stale-bot/ignore Indicates that this issue / PR shall not be closed by our stale-checking CI
Milestone

Comments

@polarathene
Copy link
Member

polarathene commented Jan 17, 2024

Description

As discussed here. mailserver.env and the ENV docs aren't entirely in sync, and it adds a maintenance burden (both in maintaining it and noise it often contributes to bug reports that copy/paste the whole thing instead of only sharing what was explicitly changed).

We could convey most value with restructuring of the ENV docs, but the primary improvements for referencing/overview of ENV would be:

  • A ENV overview table at the top with key/value columns. The value being the default.
    • A third column could technically list alternative values (enum variants), or a description of the value expected.
    • Key column would list each ENV with a link to the more detailed section on that page for the ENV to get more information.
  • If using Content Tabs feature, or a collapsed admonition; we could also include a .env / compose.yaml of the ENV with empty values for easy copy/paste if that is considered helpful to users.

This would better centralize our ENV (and docs for it). Especially since the docs are better versioned, we've had users try the master branch mailserver.env instead of from a tagged release that matches their image version (although still likely to happen with the latest docs we direct users to by default 🤷‍♂️ ).

@polarathene polarathene added meta/help wanted The OP requests help from others - chime in! :D kind/improvement Improve an existing feature, configuration file or the documentation area/documentation area/configuration (file) labels Jan 17, 2024
@polarathene polarathene added this to the v15.0.0 milestone Jan 27, 2024
@polarathene polarathene self-assigned this Jan 27, 2024
@polarathene polarathene added the stale-bot/ignore Indicates that this issue / PR shall not be closed by our stale-checking CI label Jan 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/configuration (file) area/documentation kind/improvement Improve an existing feature, configuration file or the documentation meta/help wanted The OP requests help from others - chime in! :D stale-bot/ignore Indicates that this issue / PR shall not be closed by our stale-checking CI
Projects
None yet
Development

No branches or pull requests

1 participant