[svn.haxx.se] · SVN Dev · SVN Users · SVN Org · TSVN Dev · TSVN Users · Subclipse Dev · Subclipse Users · this month's index

Re: VOLUNTEER: Port dev docs to a wiki

From: Brian Behlendorf <brian_at_collab.net>
Date: 2005-10-21 08:01:24 CEST

I like Wikis. That said:

On Thu, 20 Oct 2005, Jay Levitt wrote:
> So wiki changes end up creating a very different model of documentation; they
> take advantage of the fact that we can use the same language for both the
> document itself and the conversation about the document. I think a commit
> e-mail for every wiki commit would create ridiculous volumes, and be
> counterproductive. I also think wiki editing should very explicitly *NOT* be
> restricted to commiters alone; again, your most valuable feedback is going to
> come from someone who's reading this thing for the first time, and has yet to
> write a single line of code.
> I do think it makes a lot of sense to have the wiki "funnel into" the static
> docs, with a proper review process. Perhaps I could integrate something into
> a wiki engine that flags any given version of the page as "reviewed"; if the
> last editor was not on the commit list, it could say "This page has not yet
> been formally reviewed. Click *here* for the last approved revision.". In
> fact, that seems like useful wiki functionality in general. Would that
> address concerns of documentation gone wild?

Isn't it easier to review commits, not whole pages? That's why some want
the commit emails, and those are kept on another list anyways so anyone
who doesn't want to see them doesn't have to. It's also important to
review each change separately, rather than to say "OK, TrustedCommitterBob
made the last change on this page, therefore all the other un-reviewed
changes must be OK", which it sounds like is your suggested approach.
Bob might be in a hurry just to fix one thing he saw on a page, and didn't
have time right then to review everything else.

I think making it easy to submit fixes makes sense - perhaps there's some
way where the edit-this-page link triggers a patch submission to the dev
list. To address the concern that unreviewed content might appear
authoritative, perhaps we keep the patched page around as a "suggested
improvement" linked off the unchanged page in question, with an easy way
to access all "suggested improvements" by people with authority to promote
that improvement to a core fix.


To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Received on Fri Oct 21 08:00:05 2005

This is an archived mail posted to the Subversion Dev mailing list.

This site is subject to the Apache Privacy Policy and the Apache Public Forum Archive Policy.