Call for review/edits: Bazaar Plugins Guide

[Jonathan Lange]

On Sat, Aug 15, 2009 at 3:50 PM, Ian
Clatworthy<ian.clatworthy at canonical.com> wrote:
> As proposed the other day, I've throw together a "Bazaar Plugins Guide"
> providing help on the commonly used plugins within the Bazaar community.
> I think it hangs together reasonably well. See
> http://doc.bazaar-vcs.org/plugins/en/ for the current draft.
>
> If you are a *plugin user*, please let me know how the document could be
> improved. For example:
>
> * Do the categories make sense? Should we add more?
>

Yes, they make sense. "Productivity" is a little nebulous, but I think
it's fine.

> * What plugins do you commonly use that are missing?
>

bzr-ping

> * Is the layout good? (I've gone with one page per plugin for ease of
>  printing vs one page per command say.)
>

Yes, it's great!

One thing, I think that the root page (i.e.
http://doc.bazaar-vcs.org/plugins/en/) should include a single-line
description of the plugin for each plugin. This saves clicking through
to figure out what something does.

e.g.
  * bzrtools - Various useful commands for working with bzr.
  * bookmarks - allows you to add, remove or modify a commonly used
network location.
  * bisect - Support for git-style bisection.

> * Should I add the home page for each plugin under the 'Version:'
>  metadata at the top say? Other metadata? (If so, is there an easy
>  way for me to look this data up vs maintaining it separately?)
>

I think it would be nice.

I don't know of a way to look the data up, I'm afraid.

jml