Hi all - <br>Wanted to send a note out to let people know I'm listening to the various difficulties finding accurate docs, and also provide my sense of the scope of the docs for OpenStack. <br><br>I want to have a session at the Design Summit about the blossoming docs sites but also discuss how to prune and de-dupe docs. Here are all the "doc" properties - not that I own them all, but that they are locations where people get info that can go out-of-date. I want to prioritize and focus docs for the Folsom release and welcome your input. This info is copied to this Etherpad: <a href="http://etherpad.openstack.org/folsomdocsplanning">http://etherpad.openstack.org/folsomdocsplanning</a>, feel free to edit and add as you see fit.<br>
<br>__Admin guides__<br>Where: <a href="http://github.com/openstack/openstack-manuals" target="_blank">http://github.com/openstack/openstack-manuals</a><br>
<br>What: <br>- <a href="http://docs.openstack.org">docs.openstack.org</a><br>- Compute Admin manual<br>- Object Storage Admin manual<br>- Supporting projects such as identity and image management are shared chapters inserted into each.<br>
- Network connectivity (Quantum) Admin manual<br>
<br>Who:<br>Day-to-day administrators of OpenStack clouds (public and private)<br><br>How: Updated through the git/Gerrit review process.<br><br>__Install guides__<br>Where: <a href="http://github.com/openstack/openstack-manuals" target="_blank">http://github.com/openstack/openstack-manuals</a><br>
What: <a href="http://docs.openstack.org">docs.openstack.org</a> Compute Install/Deploy guide with identity, image management, dashboard as chapters.<br>How: Updated through the git/Gerrit review process.<br><br>Where: <a href="http://launchpad.net/openstackbook" target="_blank">http://launchpad.net/openstackbook</a> <br>
What: <a href="http://docs.openstack.org">docs.openstack.org</a> Ubuntu release-based OpenStack Starter Guide for Natty (Cactus), Oneiric (Diablo), Precise (Essex) soon to be completed<br>How: Updated through bzr/Launchpad merge processes.<br>
<br>Where: <a href="http://www.hastexo.com/resources/docs/installing-openstack-essex-4-ubuntu-1204-precise-pangolin" target="_blank">http://www.hastexo.com/resources/docs/installing-openstack-essex-4-ubuntu-1204-precise-pangolin</a><br>
What: 12.04 Quick Start from Hastexo. It's a great doc, but I think it could receive even more attention and
updates if it were in the OpenStack docs umbrella, so I'm talking to the
authors about submitting it. <br><br>Who:<br>
Deployers of OpenStack clouds (public and private), proof-of-concept creators<br>
<br>__API info__<br>Where: <br><a href="http://github.com/openstack/openstack-manuals" target="_blank">http://github.com/openstack/openstack-manuals</a><br><a href="http://github.com/openstack/object-api" target="_blank">http://github.com/openstack/object-api</a> <br>
<a href="http://github.com/openstack/compute-api" target="_blank">http://github.com/openstack/compute-api</a><br><a href="http://github.com/openstack/netconn-api" target="_blank">http://github.com/openstack/netconn-api</a><br>
<a href="http://github.com/openstack/identity-api" target="_blank">http://github.com/openstack/identity-api</a><br>
<a href="http://github.com/openstack/image-api" target="_blank">http://github.com/openstack/image-api</a><br>
What: <br>openstack-manuals contains: <br>- <a href="http://docs.openstack.org">docs.openstack.org</a><br> - API Quick Start<br> - Compute API Programmer’s Guide<br>- <a href="http://api.openstack.org" target="_blank">api.openstack.org</a><br>
- OpenStack Compute extensions<br><br>Separate repos contain:<br> (pointed to from <a href="http://docs.openstack.org/api">docs.openstack.org/api</a>)<br>- OpenStack Compute API Dev Guide<br>- OpenStack Object Storage API Dev Guide<br>
- OpenStack Image API Dev Guide<br>
- OpenStack Identity API Dev Guide<br>- OpenStack Quantum API Dev Guide<br><br>Note: In making this listing I realized that Melange has an API spec at <a href="https://github.com/openstack/melange/blob/master/doc/source/apidoc.rst" target="_blank">https://github.com/openstack/melange/blob/master/doc/source/apidoc.rst</a>. Their latest commit says they make it so it builds to <a href="http://rtfd.org" target="_blank">rtfd.org</a> but I can't find it on that site. Note sent to Dan and Troy.<br>
<br>Who: API programmers, Python developers<br>How: Updated through the git/Gerrit review process.<br><br>__Wiki__<br>Where: <a href="http://wiki.openstack.org" target="_blank">http://wiki.openstack.org</a><br>What: Release notes, project status and process information, very little how-to <br>
Who: Contributors to the OpenStack projects<br><br>__Developer info__<br>Where: <a href="http://github.com/openstack/nova/" target="_blank">http://github.com/openstack/nova/</a><br><a href="http://github.com/openstack/swift/" target="_blank">http://github.com/openstack/swift/</a><br>
<a href="http://github.com/openstack/keystone/" target="_blank">http://github.com/openstack/keystone/</a><br><a href="http://github.com/openstack/glance/" target="_blank">http://github.com/openstack/glance/</a><br><a href="http://github.com/openstack/horizon/" target="_blank">http://github.com/openstack/horizon/</a><br>
<a href="http://github.com/openstack/openstack-ci/" target="_blank">http://github.com/openstack/openstack-ci/</a><br><br>What:<br><a href="http://nova.openstack.org" target="_blank">http://nova.openstack.org</a> <br><a href="http://swift.openstack.org" target="_blank">http://swift.openstack.org</a> <br>
<a href="http://keystone.openstack.org" target="_blank">http://keystone.openstack.org</a> <br><a href="http://glance.openstack.org" target="_blank">http://glance.openstack.org</a><br><a href="http://horizon.openstack.org" target="_blank">http://horizon.openstack.org</a><br>
<a href="http://ci.openstack.org" target="_blank">http://ci.openstack.org</a><br><br>__Main website__<br>Where: Silverstripe CMS with a few people with logins<br>What: <a href="http://openstack.org" target="_blank">openstack.org</a> and all pages in it<br>
Who: People who want to learn about OpenStack, community members, company members<br><br>__Related websites__<br>Where: <a href="http://github.com/openstack-dev/devstack">http://github.com/openstack-dev/devstack</a><br>What: <a href="http://devstack.org">http://devstack.org</a> <br>
<br>Where: not sure, probably Silverstripe CMS with a few people with logins<br>What: <a href="http://trystack.org">http://trystack.org</a><br>Who: People who want to learn about OpenStack, community members, company members<br>
<br>__Third party blogs and websites__<br>Where: The Internet<br>What: How-to and conceptual information about OpenStack<br>Who: Bloggers<br>
How: I tend to link to good how-to information from bloggers at <a href="http://wiki.openstack.org/BloggersTips" target="_blank">http://wiki.openstack.org/BloggersTips</a>. Better curation methods would be great. I also contact bloggers directly and work with them to bring in CC licensed content to openstack-manuals.<br>
<br>Yes, this is a long list. Yes, this is the Internet. Yes, I have ideas for how to manage all this content, and I'd welcome yours as well. <br><br>Thanks for reading this far! Join us at the Summit to discuss in person.<br>
Anne<br>