flood docs online

[Jacek Prucia <ja...@acn.waw.pl>]

I've uploaded initial version of flood docs to my commiter homepage:

http://cvs.apache.org/~jacekp/flood-docs.html

Both XML sources and XHTML (for on-line viewing) are available. This is only
an alpha draft, but some suggestions/opinions would be nice. In particular, I
would like to see if there any comments on configuration element syntax (that
is -- chapter 6). I've put only one element there -- <flood> (other elements
need a little bit of work) as an example. It is sort of descriptive DTD with
few additional informations like list of parent elements and severity of
character data. This seems to be de facto standard (at least for Bea, Sun and
IBM), but I'm open to suggestions.

The only problem remaining is how to put all that stuff into CVS. I think
following directory structure schould work:

docs/
   docbook/
      flood.xml
   manual/
      index.html
      ...

We could keep that off flood build system (at least for now) and put all
information needed to build docs into README file. Then just before release,
we could transform XML sources into HTML and populate docs/manual.

Yeah, I know that sucks, but we can rethink everything later (post flood 1.1).

regards,
Jacek Prucia

Re: flood docs online

[Justin Erenkrantz <ju...@erenkrantz.com>]

--On Thursday, May 29, 2003 8:52 PM +0200 Jacek Prucia 
<ja...@acn.waw.pl> wrote:

> The only problem remaining is how to put all that stuff into CVS. I think
> following directory structure schould work:
>
> docs/
>    docbook/
>       flood.xml
>    manual/
>       index.html
>       ...

Sounds fine to me as a starting point.  +1.

> We could keep that off flood build system (at least for now) and put all
> information needed to build docs into README file. Then just before release,
> we could transform XML sources into HTML and populate docs/manual.

Sure - that'd work for now.  If I get a chance (when things settle down over 
here), I'll take a pass at incorporating a 'doc' target or something if no one 
has beaten me to it.

> Yeah, I know that sucks, but we can rethink everything later (post flood
> 1.1).

Docs look good at first glance.  Cool!  Woot!  =)  Thanks!  -- justin