<div dir="ltr">I applaud Julien's note and we're happy to work with the teams on finding where docs should go. Julien's feeling very behind, and I'm sure other projects are feeling the same. <div><br></div>
<div><div>We all have to set priorities. Here's where I'd start. </div></div><div><br></div><div>Log doc bugs in openstack-manuals for:</div><div>installation</div><div>configuration</div><div>day-to-day running</div>
<div>end-user tasks</div><div>admin tasks</div><div>troubleshooting</div><div><br></div><div>Log doc bugs in openstack-api-site for:</div><div>API reference docs</div><div><br></div><div>Ensure your configuration information is updated as it is now being scraped with a script to go into the Config Ref.</div>
<div><br></div><div>Assign knowledgeable team members to the doc bugs. Come to #openstack-doc on IRC to ask which files to update. Recruit writers and reviewers.</div><div><br></div><div>Go go go!</div><div><br></div><div>
Thanks,</div><div>Anne</div><div><br></div></div><div class="gmail_extra"><br><br><div class="gmail_quote">On Fri, Aug 30, 2013 at 8:22 AM, Davanum Srinivas <span dir="ltr"><<a href="mailto:davanum@gmail.com" target="_blank">davanum@gmail.com</a>></span> wrote:<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div dir="ltr">How about mandating that when one adds a DocImpact in a review it should have a url to an etherpad/wiki with sufficient information for the doc team? yes, +1 to let docs team figure out where to fit it into existing guides.<div>
<br></div><div>-- dims</div></div><div class="gmail_extra"><div><div class="h5"><br><br><div class="gmail_quote">On Fri, Aug 30, 2013 at 9:01 AM, Russell Bryant <span dir="ltr"><<a href="mailto:rbryant@redhat.com" target="_blank">rbryant@redhat.com</a>></span> wrote:<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">-----BEGIN PGP SIGNED MESSAGE-----<br>
Hash: SHA1<br>
<br>
On 08/30/2013 08:39 AM, Julien Danjou wrote:<br>
> Hi team,<br>
><br>
> We need to get better at documentation. We are terrible at it. We<br>
> let code go through the gates knowing that our documentation isn't<br>
> up to date. We have features implemented 6 months ago still not<br>
> documented. Nobody's going to do it for us.<br>
><br>
> Therefore I strongly suggest that as soon as you spot that the<br>
> documentation must be updated to reflect any change, you score -1<br>
> the patchset to oblige the submitting developer to write some<br>
> prose.<br>
<br>
This is something we could get better at across all of OpenStack.<br>
<br>
I've been thinking about proposing requiring docs *somewhere* for<br>
everything that affects docs. For small stuff, it could be explaining<br>
it especially well in the commit message. For larger stuff, it could<br>
be covered on the blueprint or wiki page.<br>
<br>
I think at the least, we could provide some of the core information so<br>
that the docs team is left with figuring out where best to fit it into<br>
the existing guides, as opposed to generating the content from scratch.<br>
<br>
- --<br>
Russell Bryant<br>
-----BEGIN PGP SIGNATURE-----<br>
Version: GnuPG v1.4.14 (GNU/Linux)<br>
Comment: Using GnuPG with Thunderbird - <a href="http://www.enigmail.net/" target="_blank">http://www.enigmail.net/</a><br>
<br>
iEYEARECAAYFAlIgl4wACgkQFg9ft4s9SAZxlACgq6BZVx8zW7XLxjis4FootwOD<br>
qCMAoI3ztfBMetE13TJ3ZjZ+sLaQVPrx<br>
=W0H0<br>
-----END PGP SIGNATURE-----<br>
<br>
_______________________________________________<br>
OpenStack-dev mailing list<br>
<a href="mailto:OpenStack-dev@lists.openstack.org" target="_blank">OpenStack-dev@lists.openstack.org</a><br>
<a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev" target="_blank">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev</a><br>
</blockquote></div><br><br clear="all"><div><br></div></div></div><span class="HOEnZb"><font color="#888888">-- <br>Davanum Srinivas :: <a href="http://davanum.wordpress.com" target="_blank">http://davanum.wordpress.com</a>
</font></span></div>
<br>_______________________________________________<br>
OpenStack-dev mailing list<br>
<a href="mailto:OpenStack-dev@lists.openstack.org">OpenStack-dev@lists.openstack.org</a><br>
<a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev" target="_blank">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev</a><br>
<br></blockquote></div><br><br clear="all"><div><br></div>-- <br>Anne Gentle<br><a href="mailto:annegentle@justwriteclick.com" target="_blank">annegentle@justwriteclick.com</a>
</div>