Short, task-based bzr doclets for real-world use cases.

John Arbash Meinel john at arbash-meinel.com
Wed Jan 21 17:16:49 GMT 2009


-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Karl Fogel wrote:
> John Arbash Meinel <john at arbash-meinel.com> writes:
>> If I can give one recommendation to start with, can you use ReST for the
>> documentation, rather than Moin syntax? Our wiki supports both. I'll go
>> ahead and convert over the couple of ones that you've done so far. The
>> big reason is that it is consistent with our internal documentation, and
>> means we can just grab the wiki page and paste it into a file if we want
>> to move it to being bundled with the rest of bzr.
> 
> Sure, no problem.  I've never used ReST, but it's "ReStructured Text"
> format, right?  (Not to be confused with "REST".)  Can't be too hard.

Right. I updated the Bugfix and Scenarios pages. The sites I use for
reference are:
http://docutils.sourceforge.net/rst.html
and
http://docutils.sourceforge.net/docs/user/rst/quickref.html

The latter is a pretty good "reference card" for quick "how do I do that
again" questions.

> 
>> I hate to nominate someone else, but I'll have to say that so far Ian
>> has been doing a great job on refining our documentation, and would
>> probably fit a good role as "editor". It is certainly up to him if he
>> wants to take the job. I'm just giving him credit for what we have done
>> so far.
> 
> Ian, are you up for it?
> 
> I don't think you'd have to write the documents, just review and edit
> others' contributions.  (Anyway, as far as writing new text goes, you've
> got your hands full with the Users Guide plans :-) ).
> 
> -Karl
> 

John
=:->
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.9 (Cygwin)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org

iEYEARECAAYFAkl3WIEACgkQJdeBCYSNAANoPgCg0LThxvh+DI4cutC77oMwynvk
z1YAoLVtIxWkg7fMLMd99alH4aforKxX
=kRBz
-----END PGP SIGNATURE-----



More information about the bazaar mailing list