The OpenStack Blog

Dedicated Doc Day

Rather than having a doc sprint session at the upcoming Summit, I’ve decided to do a push for docs for Cactus with a single two dedicated doc days this Wednesday, April 6th, and Wednesday, April 13th. I’d like to get us all on the same page with this post. (Ha, page.)

I track my doc tasks with a bunch of Post-it notes on my white board, and I’ve moved a lot from In Progress to Done this release. But I want to have a day dedicated to OpenStack docs to keep adding supporting documentation to the project.

OpenStack doc task board

Scope

The priorities for Cactus were clearly on reference documentation for flags and the API for Compute, and for Object Storage, logging information. We’ve had great efforts here which are rolled into the openstack-manuals Launchpad project and automation surrounding flags is available in Nova.

I’ve published a draft for the Compute Admin Guide for Cactus and plan to place a new home page so that readers can peruse either Bexar or Cactus (trunk) documentation. For the dedicated doc day, the scope is narrowed to these topics:

Target Audience

As you well know, OpenStack provides documentation for developers and system administrators both. The RST-sourced documentation is for developers and the DocBook-sourced docs are for system and cloud administrators. This dedicated doc day invites writers for both audiences, with a focus on the topics above.

Location

I’ll be in San Francisco at the headquarters-formerly-known-as-Anso HQ on Wednesday (update: 4/13). We don’t have room for additional writers right now, though, but contact me if you’re up for a group dinner that evening.

After a long day of writing and diagramming, we’ll need libations. I’ll post a place for a meetup in the Mission area of San Francisco once we determine a location.

Closing Haiku

And lastly, a haiku from Daniel Green, who wrote a Doc Sprint haiku for Atlassian and won their doc sprint haiku contest:

No time to eat now.
Should be writing more content.
Too late, never mind.

Category: Documentation, Event | Tags: , , Comment »

blog comments powered by Disqus

Back to top