[RFC] New look official documentation site

Ian Clatworthy ian.clatworthy at canonical.com
Fri Jul 24 12:06:05 BST 2009


Right now, our official documentation site looks like this:
http://doc.bazaar-vcs.org/. It's both ugly and hard to use, given the
interesting links appear at the end of the page.

I'd like to give it a fresh new look consistent with the theme of the
pending 2.0 docs. See http://doc.bazaar-vcs.org/en/. Note that the links
for 1.18dev now point through to the new look per-version documentation
site and download the new look docs as well. Please go ahead and
road-test these in anger!

If that looks OK to everyone, I'd like to get some volunteers to create
matching sites for non-English languages. If you're interested, please
grab the branch from lp:~ian-clatworthy/+junk/bzr-alldocs and make some
edits. That branch already has the "en" subdirectory and creating a site
for other languages is easy:

1. cp -r en xx
2. edit xx/_templates/*.html and localise accordingly.
3. You may need to tweak a setting or two in xx/conf.py as well.

To test, install sphinx and run 'make html'.

I'm offline for the first 4 days next week. When I return, I'll create a
bzr-alldocs project so those wishing to help can put forward merge
proposals. It would be *really* cool to have the top level doc site in
several languages by 2.0, even if the documents themselves aren't
translated beyond those currently available (English, Russian, Spanish).

Maybe the "Docs" link on the home page (Wiki) ought to point to the new
site soon, instead of http://bazaar-vcs.org/Documentation. Before then,
it would be good to get the jp quick reference cards into the build I guess.

Thanks in advance for any feedback/assistance anyone offers,
Ian C.




More information about the bazaar mailing list