Documentation reorganisation

Ian Clatworthy ian.clatworthy at internode.on.net
Thu Aug 2 03:39:11 BST 2007


Martin Pool wrote:

> I think we should directly link to the quick reference card, rather than
> having the stubby page http://bazaar-vcs.org/BzrQuickReference
> 
> I guess the user guide will be put into a Bazaar branch and generated from
> ReST?  We could still have direct links into various interesting bits of
> it.
> 
> Maybe 'Giving Back' should change into a link to the core developer guide?
> I wonder whether that should be just a chapter in the overall
> developer guide.  I can see how you'd have some material that's
> interesting only to people writing plugins vs contributing to Bazaar
> itself, but there's also a lot of overlap.

My plan here is to get the structure within our tree agreed (see other
email today) and then we can have several of us working in parallel to
progressively get stuff off the Wiki into that tree.

> Wow, the glossary is quite good now.  That maybe also should go into the
> user guide, but perhaps should be also linked from this page.
> http://bazaar-vcs.org/BzrGlossary

Yes, I think it needs to go into the Guide as well as being available
stand-alone.

> I think much of the General Information section should be moved to be
> accessible through the web site menus, rather than as documentation.
> 'Community' in particular might be better under 'Community' on the wiki.

Done.

> Maybe '3rd Party Tools' and 'BzrEnhances' should be combined with plugins?
> Even if they're not technically plugins, from the user's point of view
> they are things that go together with Bazaar.

Maybe. Right now, the Plugins page asks not to put non-free stuff there.
We definitely need somewhere for everything that makes up the wider
Bazaar world. For now, I've put these under the Community page in a
section titled "Beyond the Core". Hope that name is not too lame.

Ian C.



More information about the bazaar mailing list