Obsolete:Documentation/ToDo

Starting a Documentation To-Do list, not necessarily in priority order.

At the OpenStack Design Summit we talked about priorities for the Diablo and E releases. See the Etherpad for notes at http://etherpad.openstack.org/openstack-manuals. For the Cactus release, the priority was OpenStack API documentation and flag documentation. For Diablo, the hope is to catch up the Nova documentation by integrating Keystone doc for authorization and describe the packaging efforts around Nova. For Swift, incremental releases are also integrating Keystone and the docs should reflect this as well.

Here's a brief to-do list based on incoming requests. Feel free to contact Anne Gentle (anne at openstack dot org) to sign up for any of these tasks.

1. Create schema doc pages like http://docs.rackspace.com/servers/api/v1.0/ using the source from openstack-manuals/trunk/doc/source/docbkx/openstack-compute-api-1.1/xsd.
2. Consolidate installation docs for Nova to give one happy path, ensuring that the happy path is tested and a green light indicates it's good to go.
3. Flag change in nova.conf for diablo release - flag is vlan_interface and default changed from 'eth0' to None. When creating networks, you also have to pass in the bridge_interface to use, so nova-manage instructions need updating too.
4. Write ajax console doc - start with http://wiki.openstack.org/WebBasedSerialConsole, contact person is Anthony Young, sleepsonthefloor on IRC
5. Figure out drawn character placement for docs.openstack.org
6. Write Hypervisor docs - Xen, KVM, qemu, hyper-v - in openstack-manuals (Todd Deshane would like to write Xen chapter in openstack-manuals)
7. Benchmarking for Swift
8. Work with Trey to get docs onto other sites for Xen server implementations
9. Test localization on OpenStack wiki
10. Getting Started document for Stack on a Stick (Anne sent to Dustin Kirkland, but it doesn't include Swift SAIO)
11. Use MySQL Workbench to update the database schema diagrams on NovaDatabaseSchema
12. Epub output.
13. Rating on docs with a feedback form if rating is less than a 5 of 5.
14. Begin marking up Swift dev guide with OpenStack/Rackspace conditions to enable single-sourcing of that document.

Doc Bugs

You can log a documentation bug against any project including nova, swift, glance, and the openstack-manuals project. Use the "documentation" tag when you log a doc bug in any project.

These bugs are then all viewable on Launchpad at https://bugs.launchpad.net/openstack/+bugs?field.tag=documentation

Questions that have come in on IRC lately:

• Are there recommended file system structures for OpenStack Compute?
• Networking: How does the Nova Network component route network traffic? Does it get affected when the compute host goes down?
• Networking and Projects and Users: What are the relationships between networks and projects, what are best practices for particular use cases?