<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=Windows-1252">
</head>
<body dir="auto">
<div>Sean like. Thanks!<br>
<br>
~sean</div>
<div><br>
On Jul 24, 2013, at 12:22, "Anne Gentle" <<a href="mailto:anne@openstack.org">anne@openstack.org</a>> wrote:<br>
<br>
</div>
<blockquote type="cite">
<div>
<div dir="ltr">
<div class="gmail_extra" style="">Hi all, </div>
<div class="gmail_extra" style="">Thanks for the reviews so far! This is what I plan to send in 2 hours to the openstack-dev mailing list. Please let me know any additional comments. </div>
<div class="gmail_extra" style="">Thanks,</div>
<div class="gmail_extra" style="">Anne</div>
<div class="gmail_extra"><br>
</div>
<div class="gmail_extra">Program Name: OpenStack Documentation<br>
PTL: Anne Gentle<br>
Mission Statement: Provide documentation for core OpenStack projects to promote OpenStack. Develop and maintain tools and processes to ensure quality, accurate documentation. Treat documentation like OpenStack code.<br>
<div><br>
</div>
<div>Details: Documentation is an essential effort to meet the goals of the OpenStack mission. We collaborate tightly with development and maintain open tools and processes like OpenStack development. We review each other's patches, continuously publish, track
doc bugs and monitor code patches for doc impact. We provide documentation for installation and system administration of OpenStack clouds at
<a href="http://docs.openstack.org">http://docs.openstack.org</a>. We provide API documentation for cloud consumers at
<a href="http://api.openstack.org">http://api.openstack.org</a>. </div>
<div><br>
</div>
<div>The docs-core team consists of about 20 members who review documentation patches, log and triage doc bugs, moderate comments on the documentation, write documentation, provide tooling for automation and publication, and maintain search and navigation for
the <a href="http://docs.openstack.org">docs.openstack.org</a> and <a href="http://api.openstack.org">
api.openstack.org</a> sites. We also support community-centric book sprints, intensive documentation efforts focused on a single deliverable.</div>
<div><br>
</div>
<div>We offer a framework and tools for creating and maintaining documentation for OpenStack user roles as defined by the User Committee [1]:</div>
<div> </div>
- A consumer who is submitting work, storing data or interacting with an OpenStack cloud<br>
- An operator who is running a public or private openstack cloud<br>
- An ecosystem partner who is developing solutions such as software and services around OpenStack. This corresponds to the “built for openstack” trademark requirements.<br>
- A distribution provider or appliance vendor that is providing packaged solutions and support of OpenStack<br>
<div><br>
</div>
<div>
<div>Expected deliverables and repositories:</div>
<div>The OpenStack Documentation program maintains and governs these repositories:</div>
<div>openstack/openstack-manuals</div>
<div>openstack/api-site</div>
<div>openstack/operations-guide</div>
<div><br>
</div>
<div>These repositories are co-governed with project core and docs-core having approval permissions:</div>
<div>openstack/compute-api</div>
<div>openstack/object-api</div>
<div>openstack/netconn-api</div>
<div>openstack/image-api</div>
<div>openstack/identity-api</div>
<div>openstack/volume-api</div>
<div><br>
</div>
<div>Note: One integrated project repos co-governed with project core and docs-core:</div>
<div>database-api</div>
<div><br>
</div>
<div>As an example, here is a general mapping for a project's documentation, such as the Images project, Glance:</div>
<div>
<div style="font-family:arial,sans-serif;font-size:13px">glance/doc/source/ should contain information for contributors to the Glance project itself.<br>
</div>
<div style="font-family:arial,sans-serif;font-size:13px">openstack/openstack-manuals/ contains installation and administration information. <br>
</div>
<div style="font-family:arial,sans-serif;font-size:13px">openstack/image-api/ contains API specifications.<br>
</div>
<div style="font-family:arial,sans-serif;font-size:13px">openstack/api-site/ contains API reference information only.<br>
</div>
</div>
<div><br>
</div>
<div>Since we cannot govern all documentation equally with the resources available, our focus is core first, with collaborative efforts to provide coaching and processes to complete documentation for OpenStack core and integrated projects.</div>
<div><br>
</div>
<div>Thanks for reading this far -- input and questions welcomed.</div>
<div style="">Anne </div>
<div style=""><br>
</div>
<div>1. <a href="https://docs.google.com/document/d/1yD8TfqUik2dt5xo_jMVHMl7tw9oIJnEndLK8YqEToyo/edit">https://docs.google.com/document/d/1yD8TfqUik2dt5xo_jMVHMl7tw9oIJnEndLK8YqEToyo/edit</a></div>
</div>
<div><br>
</div>
</div>
</div>
</div>
</blockquote>
<blockquote type="cite">
<div><span>_______________________________________________</span><br>
<span>Openstack-docs mailing list</span><br>
<span><a href="mailto:Openstack-docs@lists.openstack.org">Openstack-docs@lists.openstack.org</a></span><br>
<span><a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs</a></span><br>
</div>
</blockquote>
</body>
</html>