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

Reorg on Email server documentation #3031

Open
philfrei opened this issue Jan 8, 2020 · 0 comments
Open

Reorg on Email server documentation #3031

philfrei opened this issue Jan 8, 2020 · 0 comments

Comments

@philfrei
Copy link

philfrei commented Jan 8, 2020

I have a suggestion concerning the following two documents:
Email with Postfix, Dovecot, and MySQL
Troubleshooting Problems with Postfix, Dovecot, and MySQL

The "Troubleshooting" guide has two major sections, one for troubleshooting and the other being a "Step by Step Configuration" guide.

It is immensely valuable to have the Step-by-Step section, as a place where the documentation can target a less experienced audience, e.g., people (like myself!) who have coding experience but are ambitious to learn about server management and configuration. For this audience, it is appropriate for the text to be more explanatory, and include extra verification steps, as opposed to the more streamlined approach taken in the main guide.

I think the overall clarity would be well-served by breaking the "Troubleshooting" guide into two separate documents, one for troubleshooting and the other being a Step-by-Step guide.

As part of this, a mention and a link to the new "Step-by-Step" guide should be in the main guide. (This can be done even now, with a link to the Step by Step Configuration section as it currently exists.

The intro text currently reads as follows:

In this guide, you’ll learn how to set up a secure virtual user mail server with Postfix, Dovecot, and MySQL on Debian or Ubuntu. We’ll explain how to create new user mailboxes and send or receive email to and from configured domains.

I would propose adding a line such as the following:

For those of you who are willing to take a longer path, we have an alternative Step by Step Configuration guide which breaks the task down into smaller steps while focusing on providing a deeper understanding of each component.

I certainly would have opted for this, and saved a solid week or more of time, had I known about this guide beforehand!

One additional suggestion: in the Step-by-Step guide, it might be useful to include, at the beginning, an explanation of how to "reset" the system prior to commencing (i.e., making use of apt-get purge options), as an optional beginning step for those who are undertaking this guide after having attempted and failed at the main guide.

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

No branches or pull requests

1 participant