cocoon-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "John Morrison" <john.r.morri...@ntlworld.com>
Subject RE: Document Gestation Process?
Date Tue, 30 Apr 2002 16:23:54 GMT
See comments inline...

> From: Diana Shannon [mailto:terracare@mac.com]
> 
> On Tuesday, April 30, 2002, David Crossley wrote:
> 
> > Diana Shannon wrote:
> >> How will new docs, authored by Cocoon users, come to life? Here's my
> >> current idea, along with some questions.
> >
> > Here is my proposed process. I hope that it helps to arrive
> > at a combined solution.
> 
> Overall, this is a great use of existing resources, something we can 
> quickly implement. I agree with everything, and added only a few 
> comments below. We may need to bend this a bit when someone just wants 
> to donate a finished doc, something they wrote for a different purpose 
> (a thesis, presentation, article). Clearly we don't need this for FAQ 
> submissions, do we?
> 
> > 3. Author consults topic status list (a web page on cocoon web site)
> > to make sure no other draft on this topic is in process. Author sends
> > patch via bugzilla to topic-status.xml to claim the topic.
> Patch should include not only the topic but also the desired doc type, 
> don't you think?

Doc type?  A patch is a difference between what is and what's wanted,
doc type doesn't come into it... or am I totally missing something?

> > 5. Submit patch to Bugzilla to get new outline added to scratchpad.
> > When it is finally into CVS, then send email announcement calling
> > for a "[REVIEW] this-document-name".
> Who sends the email announcement? The author? The committer who adds the 
> patch to the scratchpad? Also, the author needs to subscribe to 
> cocoon-dev.

Rather than marking it as a [PATCH] could we add functionality to the
auto patch emailer for [REVIEW] or [DOC PATCH]?

> > 8. When author gets the go-ahead, they expand the outline to
> > become the first draft. They send patches via Bugzilla as before
> > and commits still go into CVS scratchpad.
> How long should this take? I hope no too long. Authors won't always be 
> able to wait indefinitely. Some only have small windows of time 
> available for writing because of other work/vacation/other needs.

If somebody feels that the patch has no conflicts/issues (as is usually
the case for docs but not for code) then the progression from bugzilla
to cvs *can* be quite quick.  Having said that, somebody to volunteer
to keep an eye on this is always welcome... :)

> > 9. Author reaches a stage where they are happy to have others
> > add input and flesh out any holes. They have flagged any known
> > deficiencies using the <note>FIXME: ... </note> convention. Send
> > announcement to list.
> These notes about holes could appear in outlines. An author shouldn't be 
> discouraged if he/she can't fill in one part of their outline...

Totally - also somebody else should feel free to fill a hole.

> > This all hinges on the need to have the Cocoon website updated
> > very often (so as to get the "topic list" out in the open). At the
> > moment the website is just updated after every code release
> > which is not often.
> 
> I agree. Is this a function of someone (who?) simply making more 
> frequent manual updates? What is the current time frame for implementing 
> automated updates?

At the moment, manual.  This is (one) of the things Forrest is for.

> As a fallback, we could also post document topic summaries to both lists 
> (as is the case with the patch queue).

See earlier comment re patch emailer.

> > One other key point is that there cannot be any single-person
> > bottleneck. Opensource is all about a community working
> > together where no particular person is responsible, yet everyone
> > is responsible.
> 
> Of course. You've eliminated a lot of potential bottlenecks. Great job!
>
> Diana

Well done everyone who's involved.

J.

---------------------------------------------------------------------
To unsubscribe, e-mail: cocoon-dev-unsubscribe@xml.apache.org
For additional commands, email: cocoon-dev-help@xml.apache.org


Mime
View raw message