cloudstack-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Joe Brockmeier <...@zonker.net>
Subject Re: doc hacking at Hack Day at CCC13
Date Mon, 17 Jun 2013 18:44:51 GMT


On Sat, Jun 15, 2013, at 09:27 AM, Daan Hoogland wrote:
> To all of you planning to hack away at documentation:
> 
> There is quite a lot of commeted out code. And there is quite a lot of
> code
> uncommented; classes and public/protected and package scope methods
> without
> description. I have not taken up the job of improving on this. Instead I
> have been swearing at others for it, for which i apologise.
> 
> Both Joe Brockmeier and Mike Tutkowski have useful proposals for doc
> improvement and I want to call on them to devise doc-from-code generation
> tooling to achieve their goals. (but i call not just on them of course)

Can you expand on this? 

We already generate API docs from the code. Generally when I talk about
docs, I'm referring to implementation docs - e.g. "how do I set up,
install, and manage CloudStack" docs.

Best,

jzb
-- 
Joe Brockmeier
jzb@zonker.net
Twitter: @jzb
http://www.dissociatedpress.net/

Mime
View raw message