review of doc updates
Martin Pool
mbp at canonical.com
Thu May 19 16:48:18 UTC 2011
We talked a bit this afternoon about our doc update process could be
improved, provoked by Maritza's question the other day about update vs
revert:
* not generally speaking many updates to docs relative to code
changes: on the other hand, many are bug fixes rather than
* some things that are not recommended are too prominent (eg sftp);
some things that are useful are hidden (eg stacking). This happens
both within single documents and also that eg the developer guide is
buried in the developer documentation.
* googling for random bzr things tends to find old documentation,
including old versions of the current documentation. (perhaps
actually take down the old docs, or have prominent links to the latest
versions of the docs.)
* /latest link is out of date (now fixed)
* not always adding new documentation when adding new features.
* idea: the 'What's new' document is good; probably someone should
read through the rest of the documentation with these changes in mind
and see whether there are any changes needed
* 66 open 'doc' bugs in <https://bugs.launchpad.net/bzr/+bugs?field.tag=doc>
Martin
More information about the bazaar
mailing list