<div dir="ltr"><br><div class="gmail_extra"><br><br><div class="gmail_quote">On Thu, Dec 12, 2013 at 2:01 AM, Emilien Macchi <span dir="ltr"><<a href="mailto:emilien.macchi@enovance.com" target="_blank">emilien.macchi@enovance.com</a>></span> wrote:<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
<div 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 href="https://review.openstack.org/#/c/61296/1/doc/build_doc.sh" target="_blank">https://review.openstack.org/#/c/61296/1/doc/build_doc.sh</a><br>
<br>
</div>
<blockquote 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 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
<a href="http://docs.openstack.org" target="_blank">docs.openstack.org</a>. That's why I CC the ML, and I would like to have
feedback from Anne Gentle.<br></div></blockquote><div><br></div><div><br></div><div>Hi Michael, and thanks Emilien. </div><div><br></div><div>We don't host content for non-official projects on <a href="http://openstack.org">openstack.org</a> web pages. Our mission statement prioritizes core over integrated even. Incubating projects tend to publish to <a href="http://readthedocs.org">readthedocs.org</a> as they are building using Sphinx. Any way to wrap it up in a sphinx build? </div>
<div><br></div><div>Anne</div><div><br></div><div> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div bgcolor="#FFFFFF" text="#000000">
<blockquote 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 href="http://puppet-openstack.com" target="_blank">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 type="cite">
<div dir="ltr">
<div><br>
</div>
<div> - Michael<br>
</div>
</div>
<br>
</blockquote>
<br>
Thank you Michael to bringing that!<span class="HOEnZb"><font color="#888888"><br>
<pre cols="72">Emilien Macchi</pre>
<br>
<br>
</font></span></div>
<br>_______________________________________________<br>
Openstack-docs mailing list<br>
<a href="mailto:Openstack-docs@lists.openstack.org">Openstack-docs@lists.openstack.org</a><br>
<a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs" target="_blank">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs</a><br>
<br></blockquote></div><br></div></div>