Obsolete:Documentation/ToDo
Starting a Documentation To-Do list, not necessarily in priority order.
For a discussion of Documentation priorities for the Cactus release, refer to http://eavesdrop.openstack.org/meetings/openstack-meeting/2011/openstack-meeting.2011-02-08-21.00.log.html and scroll to #topic Documentation priorities for Cactus. Top priority so far is OpenStack API documentation. Also listed is flag documentation.
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.
- Document and test VM image fixes for http://wiki.openstack.org/NovaVirtually so that a Bexar (2011.1.1 release) works on VM
- Write ajax console doc - start with http://wiki.openstack.org/WebBasedSerialConsole, contact person is Anthony Young, sleepsonthefloor on IRC
- Write better flags documentation - start with http://wiki.openstack.org/FlagsGrouping, which ThierryCarrez wrote, and we should take it over to docs.openstack.org in the openstack-manuals project and add configuration how-tos. (Anne Gentle in openstack-manuals, much of it is in trunk, can still be added to for certain)
- Get Glance installation on docs.openstack.org - docbook XML files exist in openstack-manuals but needs to be included in Compute Admin book and tested (Anne Gentle in openstack-manuals, source is in trunk, output has not yet been generated)
- Write sidebar content for docs.openstack.org (Anne Gentle in openstack-manuals, testing in the compute manual source)
- Figure out drawn character placement for docs.openstack.org
- Write Hypervisor docs - Xen, KVM, qemu, hyper-v - in openstack-manuals (Todd Deshane would like to write Xen chapter in openstack-manuals)
- Write wiki page about getting from code to testing (http://wiki.openstack.org/Testing)
- Document how to configure Nova to use IPv6 addresses (Done in openstack-manuals trunk source, still needs to be built to HTML/PDF)
- Document how to configure Nova to use Glance (Done openstack-manuals trunk source, still needs to be built to HTML/PDF)
- Benchmarking for Swift
- Email Kei (Masumotok at NTT) to tell him how to contribute docs for live migration (Anne Gentle)
- Work with Trey to get docs onto other sites for Xen server implementations
- Write up how docs.openstack.org works in detail (Anne Gentle)
- Fix file naming and chunking with docbook output (Done - Anne Gentle/David Cramer)
- Test localization on OpenStack wiki - see also http://www.openstack.or.kr/wiki/index.php/OpenStack
- Double-check Nova networking images that should be added to nova.openstack.org site (Anne Gentle)
- Getting Started document for Stack on a Stick (Anne sent to Dustin Kirkland, but it doesn't include Swift SAIO)
- Document RHEL6 installation on docs.openstack.org from http://wiki.openstack.org/NovaInstall/RHEL6Notes - contact is BK_man on IRC
- Write additional information about making images that work well with OpenStack - add to the DocBook file in the openstack-manuals project (Mark Pace)
Doc Bugs
You can log a documentation bug against any project including the openstack-manuals project. Here's a listing of doc bugs for Swift and Nova projects.
- Document all settings for Swift, even “easter eggs” (https://bugs.launchpad.net/swift/+bug/661267)
- Missing documentation about nova-api.conf; plus it's renamed api-paste.ini (https://bugs.launchpad.net/nova/+bug/705070)
- Doc missing: env http_proxy must be disabled when starting nova daemons by hand (https://bugs.launchpad.net/nova/+bug/718900)
- Add how to push out new rings to the admin guide (https://bugs.launchpad.net/swift/+bug/620586)
- Omissions in stats system on SAIO docs (https://bugs.launchpad.net/swift/+bug/680188)
- Document config options and defaults in sample configs for Swift (https://bugs.launchpad.net/swift/+bug/661267)
- Local image service has changed recently to include Glance, but docstrings in service.py were not updated to show the new format (https://bugs.launchpad.net/nova/+bug/744457)
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?