Philipp Wagner wrote:
> Bruno Negrão wrote:
> > Because there are already 10 important manpages in this section, like
> > addresses(5), envelopes(5), dot-qmail(5), etc. Creating new 19 manpages
> > there will let that section confusing, specially when browsing on the
> > manpages (I always browse the manpages on the website, that's why I
> > concern).
> 
> It's not confusing if you want to find something and not only browse
> through the qmail-manpages if you don't have anything else to do. Our
> goal has to be to make the information as easy to find as possible, and
> the ONLY (and easiest) way to do that is to have one man-page for each
> control file. It does NOT matter how many manpages we create, it
> matters, how easy they are to find.

I have already imported and marked up all qmail-ldap specific control
file documentation.  You can find all of them in the Control Files
category:

 http://www.qmail-ldap.org/wiki/Category:Control_Files

Now it would be nice to have all other control files documented in
the same way (markup and everything) as well.  Maybe some descriptions
can be made more verbose but it's a good start.

Eventuall I'd like to have the qmail-ldap Wiki with the following
structure:

 - Overview for newcomers.  This is sort of advertising.  Mostly on
   the first page (home page).

 - All control files documented on their own page with Wiki links to
   all programs reading it.  See category control files.

 - All qmail[-ldap] programs documented on their own page with Wiki
   links to all control files they read.  See category qmail programs.

 - General installation guide to get a (basic) working system.  Pretty
   much a fusion of QLDAPINSTALL and LifeWithQmail-LDAP with nice
   markup in Wiki style and not just a text dump into the Wiki.  All
   items that are qmail programs or control files should have Wiki
   links to their respective pages and full descriptions.

 - Special installation guides for collateral programs like OpenLDAP,
   Courier-IMAP, Binc-IMAP, DJBDNS, Daemontools, ucspi-tcp, etc.

 - Special installation guides for advanced features like POP before
   SMTP, Clustering, SSL/TLS, AntiSPAM, AntiVirus, etc.

 - Special concept guides.  Like way to lay out the LDAP directory,
   ways to do clustering, etc.

 - A real FAQ for truely frequently asked questions and not serving
   as kitching sink for things not covered in the documentation.  Any
   FAQ entry not pointing to a documentation section is a not good
   enough documentation.

-- 
Andre

Reply via email to