cocoon-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Diana Shannon <shan...@apache.org>
Subject Re: Wiki documentation system
Date Fri, 07 Jun 2002 12:51:46 GMT

On Friday, June 7, 2002, at 05:37  AM, Jeremy Quinn wrote:

> If we had something similar to BugZilla for documentation, that would 
> accept emailed doc updates, then the work of the editor could take 
> place on the servers set up by the users, and posted to the Doc 
> BugZilla for checking and if appropriate, inclusion.
>
> The documentation pages could be rendered (on users machines) with 
> links that allow users to bring up a form to add comment|add patch|etc. 
> This form would be processed on their own server, then sent in to Doc 
> BugZilla.

Agreed. IMO, you'd need to accept both comments (small amounts of text 
added to the bottom of a document) and doc revisions (changing existing 
content). Comments don't require as much technical or editorial review 
to decide relevancy. Revisions may sit in Bugzilla for a while.

I submitted a sample of how we could handle comment submissions to 
Forrest (within a larger community contribution framework) on the 
server. Once it's in Bugzilla, the comment file is simply added to the 
directory of the document in question. A naming convention associates it 
with the document. A pipeline with a directory generator discovers the 
association and adds links to such comments at the bottom of the 
document in question. It makes it easy for committers to just throw 
comment files into document directories. Ken made the suggestion we 
could add a form (simplified Bugzilla interface) to add the ability to 
collect comments on the live site (as well as in the distro). You'd need 
to log in to Bugzilla, and come back, prior to submitting, of course.

Still, revisions which impact the whole document could be tricky absent 
the locking associated with tradition CMS. How would you handle 
multiple, simultaneous revisions (impacting the whole file, not just a 
comment) made to the same document?

Diana


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


Mime
View raw message