<div dir="ltr"><div>Please take this survey to understand the obstacles to doc contributions. We are very interested in increasing the doc contributions and making our doc processes work well for OpenStack as it scales. I believe we can take actions based on the questions here, please send the link to OpenStack contributors as far as you can!</div>
<div><br></div><div><div><a href="https://docs.google.com/forms/d/136-BssH-OxjVo8vNoOD-gW4x8fDFpvixbgCfeV1w_do/viewform">https://docs.google.com/forms/d/136-BssH-OxjVo8vNoOD-gW4x8fDFpvixbgCfeV1w_do/viewform</a></div></div>
<div><br></div><div>1. In review and merged this past week:</div><div>We've reviewed and merged nearly 60 patches this week. I would like to see this pace increase however as we need to keep working on the backlog of over 350 doc bugs in openstack-manuals alone. We are definitely patching doc bugs with the items that landed recently, let's keep it up!</div>
<div><br></div><div>2. High priority doc work:</div><br>Install Guide, install guide, install guide. We are testing and updating and Matt Kassawara has been leading the way to get Networking scenarios tested and documented. Matt's asking an important question on the -docs list: Shall the docs support both OVS and ML2 in the installation guide (with removal of OVS in Juno instead of Icehouse?) Please join in at <a href="http://lists.openstack.org/pipermail/openstack-docs/2014-April/004204.html">http://lists.openstack.org/pipermail/openstack-docs/2014-April/004204.html</a><br>
<br>Doc bugs generated from DocImpact are also a high priority. Please refer to <a href="https://launchpad.net/openstack-manuals/+milestone/icehouse">https://launchpad.net/openstack-manuals/+milestone/icehouse</a>. As Tom noted, we need to fix six bugs a day to make our docs bug list goals. There are still 118 bugs awaiting your input. Even if you can only triage or comment on a bug, every effort helps. <br>
<br>If you prefer to work on bugs against API docs, refer to <a href="https://launchpad.net/openstack-api-site/+milestone/icehouse">https://launchpad.net/openstack-api-site/+milestone/icehouse</a>.<br><br>Release notes are a high priority. It's release time, can you tell?<div>
<br></div><div>3. Doc work going on that I know of:</div><div><br></div><div>ML2 driver documentation for compute, controller, and network nodes in Install Guides</div><div>ISO Image documentation</div><div>Trove install documentation</div>
<div>Scheduler filter documentation</div><div><br></div><div>4. New incoming doc requests:</div><div><br></div><div>Lots of users want Trove documentation. </div><div><br></div><div>5. Doc tools updates:</div><div><br></div>
<div>We will freeze on 0.10.0 of openstack-doc-tools and 1.15.0 of clouddocs-maven-plugin for the Icehouse doc builds.</div><div><br></div><div>6. Other doc news:</div><div><br></div><div>I've proposed a cross-project session for the Summit at <a href="http://summit.openstack.org/cfp/details/204">http://summit.openstack.org/cfp/details/204</a>. I'd love to hear your thoughts on these ideas -- at the session or on the list.</div>
<div>We have different docs for different audiences:<br>cross-project docs for deploy/install/config: openstack-manuals<br>API docs references, standards: api-site and others<br><br>These are written with the git/gerrit method. I want to talk about standing up a new docs site that serves these types of people with these requirements:<br>
<br>Experience:<br>Solution must be completely open source<br>Content must be available online<br>Content must be indexable by search engines<br>Content must be searchable<br>Content should be easily cross-linked by topic and type (priority:low)<br>
Enable comments, ratings, and analytics (or <a href="http://ask.openstack.org">ask.openstack.org</a> integration) (priority:low)<br><br>Distribution:<br>Readers must get versions of technical content specific to version of product<br>
Modular authoring of content<br>Graphic and text content should be stored as files, not in a database<br>Consumers must get technical content in PDF, html, video, audio<br>Workflow for review and approval prior to publishing content<br>
<br>Authoring:<br>Content must be re-usable across authors and personas (Single source)<br>Must support many content authors with multiple authoring tools<br>Existing content must migrate smoothly<br>All content versions need to be comparable (diff) across versions<br>
Content must be organizationally segregated based on user personas<br>Draft content must be reviewable in HTML<br>Link maintenance - Links must update with little manual maintenance to avoid broken links and link validation</div>
</div>