<div dir="ltr"><br><div class="gmail_extra"><br><div class="gmail_quote">On Wed, Sep 2, 2015 at 11:09 AM, Emilien Macchi <span dir="ltr"><<a href="mailto:emilien@redhat.com" target="_blank">emilien@redhat.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex">TL;DR, I propose to move our developer documentation from wiki to<br>
something like <a href="http://docs.openstack.org/developer/puppet-openstack" rel="noreferrer" target="_blank">http://docs.openstack.org/developer/puppet-openstack</a><br>
<br>
(Look at <a href="http://docs.openstack.org/developer/tempest/" rel="noreferrer" target="_blank">http://docs.openstack.org/developer/tempest/</a> for example).<br>
<br>
For now, most of our documentation is on<br>
<a href="https://wiki.openstack.org/wiki/Puppet" rel="noreferrer" target="_blank">https://wiki.openstack.org/wiki/Puppet</a> but I think it would be great to<br>
use RST format and Gerrit so anyone could submit documentation<br>
contribute like we do for code.<br>
<br>
I propose a basic table of contents now:<br>
Puppet modules introductions<br>
Coding Guide<br>
Reviewing code<br>
<br>
I'm taking the opportunity of the puppet sprint to run this discussion<br>
and maybe start some work of people agrees to move on.<br>
<br>
Thanks,<br>
<span class=""><font color="#888888">--<br>
Emilien Macchi<br></font></span></blockquote><div>Please consider the Puppet Approved criteria[1] when making decisions about documentation. In particular, we should be making sure the README contained within the module is complete. Publishing .rst docs to docs.o.o is not a substitute.</div><div><br></div><div>The READMEs and examples/ in our modules are generally inaccurate or out of date. We should focus on enhancing the content of our docs before worrying about the logistics of publishing them.</div><div><br></div><div>Colleen </div><div><br></div><div>[1] <a href="https://forge.puppetlabs.com/approved/criteria">https://forge.puppetlabs.com/approved/criteria</a></div></div></div></div>