Re: [fetchmail-devel] FAQ re-write

[Matthias A. <mat...@gm...>]

Rob MacGregor schrieb:
> Recent events have persuaded me to get my proverbial finger out and
> look at re-writing the FAQ to be more "user friendly" (and a little
> more current).
> 
> With this in mind I'm soliciting feedback before I start :)
> 
> I'm considering splitting it into a number of pages, rather than the
> monolithic page it is currently.  My current plan is that these would
> cover (including the current areas):
> 
> 1) (G) General, with an initial paragraph emphasising the need to use
> the current version BEFORE asking for help with any problems
> 
> 2) (B and F) Build problems and configuration file problems
> 
> 3) (S and I) Problems downloading email
> 
> 4) (T, D and M)) Problems passing email to your local mail system
> 
> 5) (K) Proxies and Security (including SSL and SOCKS)
> 
> 6) (R and H) Runtime problems
> 
> 7) (C and M) Configuration problems and examples
> 
> 8) (X and O) Everything else
> 
> Actually, I'd really like to get this into a Wiki because it means
> that it's easier to work on it as I get time, plus it means that
> others can easily add to/correct it as required.  I don't know if
> Berlios has such functionality though (but I do know that pbwiki.com
> is free).
> 
> Thoughts?

Your help will be very welcome.

a. the split is a good idea, although I'm not sure about the "everything
else" part and if I'd split 3) and 4) - these are often intertwined, and
we'd have to make sure 6) doesn't contain parts that belong into 3 or 4.

b. Berlios have a Wiki, but I'm a bit concerned about the packaging process
- I can't seem to find an export static pages version, but haven't got the
time now to check the site documentation for BerliOS.

Generally speaking, any Wiki we use must be able to export the whole set of
pages as static documents with working links and with marginal to zero
effort - I want to ship the FAQ with the fetchmail package; pointing users
to online sites for documentation is not something I'm eager to do - sooner
or later someone will be trying to read that info while Berlios has some
sort of downtime... oops. Can pbwiki.com export HTML and PDF?

In the hope of further discussion on the "how"

Best regards
Matthias