<html>
<head>
<meta content="text/html; charset=ISO-8859-1"
http-equiv="Content-Type">
</head>
<body bgcolor="#FFFFFF" text="#000000">
<div>Hi Michael,<br>
<br>
Let me add openstack-docs mailing list.<br>
<br>
On 12/12/2013 02:08 AM, Michael Chapman wrote:<br>
<div>
<div>Hi all,<br>
<br>
</div>
Since we (Cisco) have recently switched over to using hiera and
away from the puppet-openstack control/compute classes, we have
a lot more flexibility in setting parameters per-class via yaml.
This has lead to my realisation that we have no reference
documentation on what parameters are available, and this is
making construction of user-facing doc quite difficult.<br>
<br>
</div>
I've got a little script here that pulls in all the classes that
are used by puppet_openstack_builder and generates RDoc: <a
moz-do-not-send="true"
href="https://review.openstack.org/#/c/61296/1/doc/build_doc.sh">https://review.openstack.org/#/c/61296/1/doc/build_doc.sh</a><br>
<br>
</div>
<blockquote
cite="mid:CABf87Xk_HRq4i1j3RXXQ1FbK1u3zO9+C06iWaf6mK=0z681Pvg@mail.gmail.com"
type="cite">
<div dir="ltr">
<div>Most of the newer modules and classes are documented
correctly, but the nova module in particular is very lacking.<br>
<br>
</div>
<div>I'd like some input from the community and hopefully
Puppetlabs on a couple of things:<br>
<br>
</div>
<div> - First, is anyone doing this already and am I wasting my
time?<br>
</div>
</div>
</blockquote>
Not from our side.<br>
<blockquote
cite="mid:CABf87Xk_HRq4i1j3RXXQ1FbK1u3zO9+C06iWaf6mK=0z681Pvg@mail.gmail.com"
type="cite">
<div dir="ltr">
<div> - Second, does anyone have an opinion on where we could
host doc? <br>
</div>
</div>
</blockquote>
As an OpenStack manual contributor, I wonder if we could use
docs.openstack.org. That's why I CC the ML, and I would like to have
feedback from Anne Gentle.<br>
<blockquote
cite="mid:CABf87Xk_HRq4i1j3RXXQ1FbK1u3zO9+C06iWaf6mK=0z681Pvg@mail.gmail.com"
type="cite">
<div dir="ltr">
<div><br>
Does PL have a place for reference doc for modules that are in
the forge? If not, could we put a section in
openstack-manuals, and failing both of those should I just buy
<a moz-do-not-send="true" href="http://puppet-openstack.com">puppet-openstack.com</a>
and host it myself?<br>
<br>
</div>
<div>I'm also thinking about a gating job that checks all
parameters are documented, but that's a ways off.<br>
</div>
</div>
</blockquote>
+1 for gating, it would ensure good coverage of documentation also.<br>
<blockquote
cite="mid:CABf87Xk_HRq4i1j3RXXQ1FbK1u3zO9+C06iWaf6mK=0z681Pvg@mail.gmail.com"
type="cite">
<div dir="ltr">
<div><br>
</div>
<div> - Michael<br>
</div>
</div>
<br>
</blockquote>
<br>
Thank you Michael to bringing that!<br>
<pre class="moz-signature" cols="72">Emilien Macchi</pre>
<br>
<br>
</body>
</html>