Re: Developer Documentation

On 11/17/18 8:48 AM, Ian Turner wrote:
> More documentation is always helpful and your contributions would be
> appreciated.
> ...
> I would caution you against adding a new documentation
> format/repository, and against using ODF. My opinion (which is mostly
> irrelevant) is that it would be best to keep to existing documentation
> formats

+1

> — that means either text files, or the wiki. There used to be
> some docbook documentation but it was moved to the wiki over a decade ago.
Also not to overlook the man pages, which are still in Docbook XML
format in the source tree. HTML and PDF renderings can be generated
during the build. The HTML versions become accessible on the wiki
at https://wiki.zmanda.com/man/

The "DATA FORMATS" and "CONCEPTS" categories include material
that could be considered developer documentation (and it would be
great for the information on those pages to be expanded / kept in
sync in new documentation efforts).

And the documentation embedded in the Perl code, which also can get
built into HTML and PDF, and the HTML versions end up at
http://wiki.zmanda.com/pod/

-Chap