[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: Newbie wants to join
I propose we start with the following:
1. Agree on and figure out what tools to use for documentation ( i do not
know about XML/StyleBook where do we find it Falko?)
2. Put up a quick howto on how we do documentation (what tools and where to
find them, what list to post to user or dev etc)
3. Convert the current TeX doc into <whatever format>
4. Rearrange the doc into modules for user, admin/config and developer
5. Map out need for new areas and put stuff in along with your questions
Yanick as you go through it as you planned
----- Original Message -----
From: "yduchesne" <firstname.lastname@example.org>
Sent: Wednesday, May 23, 2001 9:56 PM
Subject: Re: Newbie wants to join
> At 10:45 AM 5/23/01 +0200, you wrote:
> Hi Falko,
> I'm glad my suggestion was received favorably. So I'm ready to start, and
> willing to manage that doc project. Could someone set up the environment
> for me (CVS)? I've looked for style-book on xml.apache.org; not there...
> Where can I get it?
> Also, should we set up a plan, I mean, in what order the different
> could be treated? I think it would be better to start with the core
> functionnality, and then move on. My goal is to provide a really complete
> doc, something that will allow someone like me to grasp the whole
> architecture. The pedagogy would go as this: explanations, definitions,
> diagram if required, and then code excerpts from the corresponding Ozone
> source. Is this too much?
> So how do we start?
> >On Tue, 22 May 2001, yduchesne wrote:
> > > Hi Falko,
> > >
> > > I have kept an eye on Ozone for the last few months. My interest in
> > > was ignited by my work with Gemstone (we use the latter at my job). I
> > > the concepts behind Ozone and I would like to familiarize myself with
> > > whole thing, before I start contributing code. Since I have absolutely
> > > experience in DBMS design & development (I use them as a tool
> > but
> > > I do not actually develop them...), I think the best way to start
> > would be
> > > to thoroughly explore the sources and try making sense from them - I
> > > done this partly, already. I would be willing to share my learning
> > > other Ozone wannabees by writing documentation about the whole
> > > architecture. I suggest to create an Ozone Documentation Project -
> > > the one of ZOPE (see zope.org).
> >Great idea!
> > > Would you - or someone else who can do it -
> > > be so kind as to guide me through the process? This could be done the
> > > following way:
> > >
> > > - I look at the sources to grasp as much information as I can
> > > - I provide you with a list of questions
> > > - I write a draft wich I submit to you
> > > - you correct/annotate the draft
> > > - I proceed to the appropriate modifications
> > > - The result is integrated as part of the Ozone Documentation Project,
> > > available online.
> > >
> > > Of course the whole process would be iterative; I could start
> > the
> > > core packages, then go to the others (xml, etc).
> >Well, all this sounds great. But we need a way to organize the work.
> >the ozone-db.org site is generated out of TeX files that are in CVS. TeX
> >is not
> >that future prove. ;) Using CVS could be a good idea. I propose the
> >- XML/stylebook to write the docs
> >- we make a new CVS module for that and initialize the stylebook
> >(Lars could you do that?)
> >- we need maintainer(s) for the ozone documentation project; Yanick? Per?
> >- at first the maintainer(s) should propose and document the workflow
> >has done this above already)
> >- converting the current docs
> >- having fun
> > >
> > > The end result could be a comphrehensive documentation of Ozone's
> > > workings, easing things up for other developers like me who want to
> > > involved; it would also be very useful for people who are considering
> > > Ozone for their project, but who in the end do not pick it because
> > > don't feel they have sufficient information about it. I believe the
> > > flaw of open-source projects is the lack of such documentation. Don't
> > > all agree that a doc project could be useful?
> >perfectly! ;)
> >Falko Braeutigam mailto:email@example.com
> >SMB GmbH http://www.smb-tec.com