Difference between revisions of "Obsolete:Documentation/ToDo"
Line 2: | Line 2: | ||
Starting a Documentation To-Do list, not necessarily in priority order. | Starting a Documentation To-Do list, not necessarily in priority order. | ||
− | At the OpenStack Design Summit we | + | 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. |
− | |||
− | |||
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. | 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. | ||
Line 17: | Line 15: | ||
# Benchmarking for Swift | # Benchmarking for Swift | ||
# Work with Trey to get docs onto other sites for Xen server implementations | # Work with Trey to get docs onto other sites for Xen server implementations | ||
− | # Test localization on [[OpenStack]] wiki | + | # Test localization on [[OpenStack]] wiki |
# Getting Started document for Stack on a Stick (Anne sent to Dustin Kirkland, but it doesn't include Swift SAIO) | # Getting Started document for Stack on a Stick (Anne sent to Dustin Kirkland, but it doesn't include Swift SAIO) | ||
# Write additional information about making images that work well with OpenStack - add to the DocBook file in the openstack-manuals project (Mark Pace) | # Write additional information about making images that work well with OpenStack - add to the DocBook file in the openstack-manuals project (Mark Pace) | ||
# Use MySQL Workbench to update the database schema diagrams on [[NovaDatabaseSchema]] | # Use MySQL Workbench to update the database schema diagrams on [[NovaDatabaseSchema]] | ||
− | # Write setup information for running more than one hypervisor (use multiple zones) in the openstack-manuals project | + | # Write setup information for running more than one hypervisor (use multiple zones) in the openstack-manuals project. |
+ | # Epub output. | ||
+ | # Rating on docs with a feedback form if rating is less than a 5 of 5. | ||
+ | # Begin marking up Swift dev guide with OpenStack/Rackspace conditions to enable single-sourcing of that document. | ||
== Doc Bugs == | == Doc Bugs == | ||
Line 27: | Line 28: | ||
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. | 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. | ||
+ | # Doc strings in service.py are confusing for S3 and objectstore. | ||
# Document all settings for Swift, even “easter eggs” (https://bugs.launchpad.net/swift/+bug/661267) | # 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) | # Missing documentation about nova-api.conf; plus it's renamed api-paste.ini (https://bugs.launchpad.net/nova/+bug/705070) |
Revision as of 20:36, 6 May 2011
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.
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.
- Need hypervisor overview docs.
- VNC Console documentation.
- Write ajax console doc - start with http://wiki.openstack.org/WebBasedSerialConsole, contact person is Anthony Young, sleepsonthefloor on IRC
- 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)
- Benchmarking for Swift
- Work with Trey to get docs onto other sites for Xen server implementations
- Test localization on OpenStack wiki
- Getting Started document for Stack on a Stick (Anne sent to Dustin Kirkland, but it doesn't include Swift SAIO)
- Write additional information about making images that work well with OpenStack - add to the DocBook file in the openstack-manuals project (Mark Pace)
- Use MySQL Workbench to update the database schema diagrams on NovaDatabaseSchema
- Write setup information for running more than one hypervisor (use multiple zones) in the openstack-manuals project.
- Epub output.
- Rating on docs with a feedback form if rating is less than a 5 of 5.
- 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 the openstack-manuals project. Here's a listing of doc bugs for Swift and Nova projects.
- Doc strings in service.py are confusing for S3 and objectstore.
- 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)
- The s3 image service isn't meant to be specified in the flag. (https://bugs.launchpad.net/nova/+bug/738371)
- The VLAN Networking example is overly complex (https://bugs.launchpad.net/nova/+bug/752738)
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?