<div dir="ltr">







<p>Happy new year everyone. We're hitting the books with a vengeance in 2014. See my 2013 roundup at <a href="http://www.openstack.org/blog/2014/01/openstack-documentation-wrap-up-for-2013/" target="_blank">http://www.openstack.org/blog/2014/01/openstack-documentation-wrap-up-for-2013/</a>. </p>



<p>1. In review and merged this past week:</p>
<p>I'm pleased to announce a refresh on the API Reference listing page thanks to Racker Ken Perkins. He removed a ton of cruft and made the site work well on mobile devices. Check it out at <a href="http://api.openstack.org/api-ref-compute.html" target="_blank">http://api.openstack.org/api-ref-compute.html</a> from your smart phone even!</p>



<p>2. High priority doc work:</p>
<p>No more backports to stable/havana after this week, so our highest priority is icehouse. A few contributors are chomping at the bit to get started on the icehouse installation doc. All hands welcomed in the next month or so.</p>

<p>3. Doc work going on that I know of:<br>
</p>
<p>Shaun is working to get the autodoc tables generated for all the projects and completed cinder and nova this week with neutron in the review queue. Thanks Shaun!<br></p><p>For the Operations Guide updates, Joe Topjian and I have addressed the first round of comments from our O'Reilly editor. We expect the remaining edits back from our editor by the middle of next week. Jan 23 and 24th are going to be sprint days on this book.</p>



<p>4. New incoming doc requests:</p>
<p>We're considering a new networking-only guide that would describe OpenStack networking options in a standalone guide. This information is especially important as a decision about nova-network looms. Please chime in on the thread at <a href="http://lists.openstack.org/pipermail/openstack-docs/2014-January/003575.html" target="_blank">http://lists.openstack.org/pipermail/openstack-docs/2014-January/003575.html</a> to encourage the creation of this standalone guide.<br>


</p><p>I had a couple of good questions about DocImpact this week so I thought I'd offer some guidance. Use DocImpact when a config setting changes, even though our autodoc tool will pick up the docstring changes, so that the doc team can determine whether further info is needed for configuration pros. You can get a pass on using a DocImpact flag if your change affects contributors only, and you put an RST change in with the patch. Otherwise, no free pass on DocImpact! Thanks to reviewers who are helping encourage better use of this flag and enhanced commit messages.</p>



<p>5. Doc tools updates:</p>
<p>We released a new version of the clouddocs-maven-plugin this week to get two enhancements to the API reference page, improved responsive HTML and PDF output as well as bug fixes. I have to say, this new look is AMAZING. Thank you Ken Perkins for the updates, what a difference it makes. The README gives the details at <a href="http://git.openstack.org/cgit/stackforge/clouddocs-maven-plugin/tree/README.rst" target="_blank">http://git.openstack.org/cgit/stackforge/clouddocs-maven-plugin/tree/README.rst</a>. </p>

<p>The openstack-doc-tools now has a 0.2 release. This repo contains our tests, autodoc tool, and schema test for docbook. Thank you Andreas for the dedicated efforts here!</p>

<p>6. Other doc news:</p><p>I can't think of anything else to report so I'll close out here!</p></div>