[Box Backup-dev] Documentation updates for 0.10

[Martin Ebourne]

Ben Summers <ben@fluffy.co.uk> wrote:
> Do you have any recommendations? The current web site is a bit  
> rubbish, and the "one long home page" style is so last century.
>
> The wiki is all very well and good, and is a wonderful tool for the  
> project, but I think we need to have an "authoritative" source for  
> documentation which can't be killed by spambots.
>
> Perhaps we could edit on the wiki, then pull it into SVN somehow, and 
>  then check that out onto the web site? Doesn't sound too much fun  
> though.

I personally would suggest:

- Official project documentation (installation guide/user manual) as 
part of the box distribution, in svn with the source.
- This could be in any of a number of source formats, don't really care 
what myself. Docbook seems to be popular at the moment I guess. Or even 
just wikitext.
- Generate html from this for the official web site
- Generate html/text for the distribution
- Maybe even man pages (wahey!)

Use the wiki for all other ancillary and/or volatile documentation.

I feel the main documentation should be in svn to gain the benefits of 
version control and the documentation matching the code. That way we 
could update the documenation for new features as we go a lot easier. 
And people could install it without being online.

Cheers,

Martin.