Hi Gilles,

> On Wed, Dec 12, 2018 at 06:39:59PM +0000, mabi wrote:
> > Hi,
> > 
> > I was wondering where did the FAQ section on the opensmtpd.org website 
> > disappear?
> > 
> > It had useful setup examples with LMTP and Dovecot if I remember 
> > correctly...
> > 
> 
> The FAQ was inaccurate and no one step and committed to maintain it.
> 
> This resulted in people mailing me in private all the time to ask why an
> example from the FAQ was not working for them.
> 
> Not opposed to having a FAQ but I can't be the one maintaining it and it
> needs to be _actively_ maintained up-to-date, not just created once then
> forgotten, otherwise this means additional work for me.

Would it be correct to say that the reason for the FAQ going out of
sync with the code is the set of changes to the grammar?

If that is the case, I propose the following OpenSMTPD operating
procedure:
When the grammar changes start, hide the FAQ.
Once the grammar changes are stabilized, update FAQ, unhide FAQ.

If I am not wrong, the new grammar is likely to persist for the
foreseeable future. As such, once the new grammar stabilizes, the need
for maintaining/rewriting the FAQ would be minimal.

To generalize even more:
When wholesale breaking changes start, hide FAQ.
When changes are stable, update FAQ, unhide FAQ.

An analogy would be svn lock and svn unlock once changes are committed.

This would balance the need to constantly update the FAQ with the
usefulness of the FAQ in helping volks in getting started with
OpenSMTPD.

Dhanyavaad.

Regards,
ab
---------|---------|---------|---------|---------|---------|---------|--

-- 
You received this mail because you are subscribed to [email protected]
To unsubscribe, send a mail to: [email protected]

Reply via email to