Documents, in bzr or wiki

Erik Bågfors zindar at gmail.com
Tue May 16 07:32:27 BST 2006


On 5/15/06, Ramon Diaz-Uriarte <rdiaz02 at gmail.com> wrote:
> On 5/15/06, Alexander Belchenko <bialix at ukr.net> wrote:
> > Erik Bågfors пишет:
> > > Just a thought, having the documentation on the wiki has been very
> > > good from a "let's get lot's of document done", but it's gotten to the
> > > point where lot's is out of date, for old versions, etc.
> > >
> > > The problem with the wiki is that some document has to say "this is
> > > supported in 0.8 and up", "this is how you do it pre 0.8, this is
> > > post", etc.  This will only get worse. It's also very adhoc, people
> > > write what they think is important.
> > >
> > > I would like us to create a new manual with a good structure, real
> > > thoughts on what should be included, and that should include
> > > tutorials.  I really find the darcs manual easy to use.
> > > http://www.darcs.net/manual/bigpage.html.  I also think that the
> > > documentation should be in the bzr branches, so that we can keep them
> > > up to date with the version in the branch and not with all versions
> > > out there.
>
> But I think that both Darcs and Monotone (another great piece of
> documentation) use a manual that is authored by just one or a few
> people. This is very different from a wiki-style work. And would
> require individual authors to commit to keeping their docs updated.
> Maybe the wiki approach is not incompatible with the "few-authors
> manual". In addition, the wiki pages can be authored by anybody, even
> those who, like myself, have only been using bzr for a week or so... I
> don't think "The" bazaar manual should be put together as a wiki, but
> should rather have more quality assurances on what goes there.

Exactly, which is why I would like to keep it in the bzr tree.  Only a
few people have commit access there. A few people would have to
approve of the documentation, as is currently with code.  This doesn't
have to be the same people, but the same process.  It works very well
for code.

/Erik


More information about the bazaar mailing list