Updated Plugins Guide - questions and RFT

Ian Clatworthy ian.clatworthy at canonical.com
Wed Sep 23 16:11:12 BST 2009


I've just published a new Plugins Guide at the usual place:
http://doc.bazaar-vcs.org/plugins/en/. As suggested by reviewers of the
first draft, this one has a short one line description of each plugin in
the table of contents. I'm yet to action many of the other suggestions
but this change alone makes it much more useful IMO.

Some questions ...

I've almost doubled the number of plugins included (26 -> 51) and there
are still plenty more I could add. Are they any plugins included that
are now obsolete and ought to be removed? Or should I add an
"Experimental" category and add some plugins into there instead of
removing them altogether?

Are there plugins you use which aren't included yet and really ought to
be? For example, is anyone using grep or hgrep? Which one should we
include in this document, if any?

I think the categories work pretty well and make it easier to find
plugins. Any objections to me reorganising the main plugin registry
(http://bazaar-vcs.org/BzrPlugins) to use the same set of categories?

I've switched the sidebar to the LHS to improve the rendering for IE 6
users. If you use IE 6, is it better now?

A request for tweaks ...

If all plugin maintainers make a small effort, we'll have great
documentation. (If you leave it to others, we won't.) Our plugins rock
and arguably double/triple the functionality of bzr itself. Let's make
them more accessible to potential users!

If you maintain a plugin and its documentation doesn't come out as
nicely as it should, click on the "Show source" link in the sidebar to
see the ReST I'm generating from your plugin trunk. You can easily fix
the formatting by editing the main docstring and by editing the
docstrings for any commands you provide. Please do that, commit the
changes and ping me to grab your changes.

You can also help potential users of your plugin by including links in
the plugin docstring. Does you plugin have a home page? Link to it from
the help. Does you plugin have a separate README with important
information? Move the information into the plugin docstring instead so
people reading the plugin help (both from the command line and in this
document) see it.

If you need assistance with ReST, see http://sphinx.pocoo.org/rest.html
for an excellent summary. If you have any questions, just ask.

Thanks,
Ian C.



More information about the bazaar mailing list