Difference between revisions of "Obsolete:Documentation/ToDo"

Latest revision as of 18:51, 25 July 2013

#!wiki caution
'''This page is outdated'''

The content of this page has not been updated for a very long time. Sections of this page are incorrect and irrelevant.

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

At the OpenStack Design Summit we discuss priorities for docs and future releases.

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.

Create hardware requirements table for Object Storage.
Identity management installation and configuration instructions improving those in http://github.com/openstack/openstack-manuals.
Write information about gathering notifications regarding system usage data in the Compute admin guide in http://github.com/openstack/openstack-manuals.
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.
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.
Write ajax console doc - start with http://wiki.openstack.org/WebBasedSerialConsole, contact person is Anthony Young, sleepsonthefloor on IRC
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)
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)
Use MySQL Workbench to update the database schema diagrams on Nova Database Schema
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 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?

@@ Line 1: / Line 1: @@
-__NOTOC__
+<pre><nowiki>#!wiki caution
+'''This page is outdated'''
+The content of this page has not been updated for a very long time. Sections of this page are incorrect and irrelevant.
+</nowiki></pre>
+{{:[[DeprecatedPage]]}}
 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.
+At the OpenStack Design Summit we discuss priorities for docs and future releases.
 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
+# Create hardware requirements table for Object Storage.
+# Identity management installation and configuration instructions improving those in http://github.com/openstack/openstack-manuals.
+# Write information about gathering notifications regarding system usage data in the Compute admin guide in http://github.com/openstack/openstack-manuals.
+# 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.
+# 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.
 # 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 all settings for Swift, even “easter eggs” (https://bugs.launchpad.net/swift/+bug/661267)
-# 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)
+# Test localization on [[OpenStack]] wiki
-# 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
+# Use MySQL Workbench to update the database schema diagrams on [[Nova Database Schema]]
-# Write additional information about making images that work well with OpenStack - add to the DocBook file in the openstack-manuals project (Mark Pace)
+# Epub output.
-# Missing documentation about nova-api.conf; plus it's renamed api-paste.ini (https://bugs.launchpad.net/nova/+bug/705070)
+# Rating on docs with a feedback form if rating is less than a 5 of 5.
-# Doc missing: env http_proxy must be disabled when starting nova daemons by hand (https://bugs.launchpad.net/nova/+bug/718900)
+# Begin marking up Swift dev guide with OpenStack/Rackspace conditions to enable single-sourcing of that document.
-# 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)
+== Doc Bugs ==
-# Document config options and defaults in sample configs for Swift (https://bugs.launchpad.net/swift/+bug/661267)
+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: