[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Ozone Doc Project

At 10:52 AM 5/26/01 -0700, you wrote:

OK,

Eric, thanks for your DocBook package, it works for me. Per, it's ok with 
me if you think what I suggested was a bit too formal. Maybe you are right; 
a too strict  approach might scare people away or tire them off after a 
while. I think then we need just an overall plan (i.e. how the docs will be 
structured), so that people who want to write will have a "slot" where to 
insert their doc in the overall project; I mean, I know now we have the 
user/developer/admin branches; but is that good enough? How do we further 
subdivide? As far as the developper doc goes for example, maybe I could 
submit a very generic Table of Contents on the mailing list (of course it 
would be incomplete, that's the point!). Other people (especially more 
experienced ones with Ozone, like your Per) could modify/annotate that TOC, 
until we obtain something under which people could work (including me), 
filling their part as time goes by. That way me make sure all documentation 
is structured coherently: no duplication, no chaos.

BTW, I will be able to generate UML diagrams since we have Together here...

Cheers

Yanick

>Per Nyfelt wrote:
> >
> > > No this is great - I had just finished passing some diffs on the current
> > > docs to Falko and was planning on working on the user doc. What you said
> > > so far is great. Can you try out what I put together and let me know how
> > > it works? Maybe one of the current experienced developers can coordinate
> > > and facilitate to keep us newbies on track. Maybe Per can be lead since
> > > he has already wrote a hacking guide.
> >
> > Sure, but we seem to have the responsibilities pretty hashed out. You take
> > on the User docs Eric, Yanick wants to give development doco a shot so he
> > will be responsible for that (Sean has some really good ideas on a more 
> full
> > UML representation and hopefully we can hash out something that will 
> fit in.
> > I'll help out with the dev doco too since I started on the Hacking 
> Howto and
> > have a lot of unfinished material that was aimed to be added to that) I'll
> > will try to create a draft on the Admin/config side since that seems to be
> > without an owner right now. Lets discuss and work on early drafts, it 
> is not
> > code so we do not need to worry about putting in stuff that is not complete
> > at this early phase. After the Documentation Howto is done i think we 
> should
> > try to put together a high level description of the content of each section
> > and make them into chapters.
> >
> > > Are you on UNIX as I put together the tools on Linux so I don't know
> > > what will happen on the Win side.
> >
> > Nope, on Win2000 right now. I'll give it a try...
>
>Okay, the ant build file should work okay and the XLST paths I think are
>all unix like so I think it should work since it is all Java. If not,
>I'm sure we can tweak some things. The ant file is very simple for one
>file so we have to decide how we want to do it for more than one doc as
>the tools take a long time to transform DocBook to HTML/FO and FOP to
>PDF.
>
>Let me know if that download works and if it does we can decide how to
>organize it to put it in CVS. We can then put together a documentation
>How-To.
>
>We might be even able to put in SVG from the UML tool as well. I haven't
>looked at ArgoUML yet so I don't know if it can spit out SVG yet.
>
>By in charge I just meant some to be the focal point and serve as sort
>of leader and tie breaker. That's it.
>
>Later,
>eric