Jump to: navigation, search


Doc Day

An OpenStack Doc Day is a day set aside before a release to ensure the documentation addresses the major features going into a release.

We have also held doc blitzes, which are hour-long review sessions. A Doc Day gives everyone the ability to set aside all code and work only on documentation for the day.

Generally you want to know the priorities for the day and the gaps we want to fill. Stay tuned to the mailing list for information specific to a particular Doc Day.

How to Participate

Currently, we use this wiki, RST files stored in source code, (ReStructured Text) and DocBook to create OpenStack's web documentation. You can use the Doc Day to write documentation with one of those methods. RST documentation is intended for Python developers. DocBook documentation is intended for devops and sys admins installing, configuring, and administering OpenStack cloud systems.

Day, Time, and Locations

Date: March 6, 2012

Time: Follow the sun starting March 6th.

Location: In person event at the San Francisco Rackspace office in the Racker Rally Room from 9:00am PST to 5:00pm PST.

RSVP: here: Essex Doc Day Meetup

Priorities: For the Essex release, these are the priorities to get documented:

  • Configuration information about new flags now available in the Essex release
  • Insert nova client commands where euca- commands are in the current documentation
  • Document API extensions for operators and cloud users, such as the Volume API
  • Set up and configuration for switching from !RabbitMQ to Qpid
  • Volume how-tos for setting up additional backends
  • Install instructions for XenServer

Etherpad for notes: http://etherpad.openstack.org/DocDayMarch6