Re: [Firebird-docs] A how-to on writing Firebird docs?

[Tilo M. <tm...@al...>]

Hi Paul,

"Paul Vinkenoog" <pa...@vi...> schrieb im Newsbeitrag
news:Pin...@so......
> > Why not use this description?
> > http://sourceforge.net/docman/display_doc.php?docid=766&group_id=1
>
> It's very lengthy, and specific to WinCVS. I'd prefer to give pointers
> to command line CVS, WinCVS and TortoiseCVS. WinCVS is fine, but
> TortoiseCVS is so easy and intuitive that it's almost a laugh! It
> also has SSH built in, unlike WinCVS.
>
> After that, a short explanation of how to ckeckout the manual module,
> with examples for all three programs. Same for update -dP. With
> read-only access, that's all they'll ever need.

When we do it we need to make sure that this documentation is always
up-to-date.
IMHO, our task should be writing Firebird docs and not redundant CVS docs. I
recommend using the SF WinCVS doc to give the user a introduction to CVS and
SSH setup at SF. Then we can simply suggest TortoiseCVS and  command line
CVS. We should also point the users to a good CVS documentation like
http://cvsbook.red-bean.com/cvsbook.html

> > I think our goal should be a nightly build of the html docs which
> > then can be made available online.
>
> That would be nice. But is this automatable on SF?

What I do for Marathon is to checkout the fresh sourcecode, compile and use
scp to put the binaries to the Marathon webspace. Of course this does not
work automatically due to my limited internet access. I can add an
appropriate build target when my time permits (in Oct.).

> Greetings,
> Paul Vinkenoog

--
Regards,
Tilo Muetze
--
Marathon - The SQL Tool for Firebird & InterBase
http://gmarathon.sourceforge.net