{"id":738,"date":"2011-04-04T11:13:22","date_gmt":"2011-04-04T16:13:22","guid":{"rendered":"http:\/\/www.openstack.org\/blog\/?p=738"},"modified":"2011-04-05T10:25:20","modified_gmt":"2011-04-05T15:25:20","slug":"dedicated-doc-day","status":"publish","type":"post","link":"https:\/\/www.openstack.org\/blog\/dedicated-doc-day\/","title":{"rendered":"Dedicated Doc Day"},"content":{"rendered":"<p class=\"lead\">Rather than having a doc sprint session at the upcoming <a href=\"http:\/\/www.openstack.org\/blog\/2011\/04\/openstack-conference-design-summit-spring-2011-sponsored-by-citrix-final-agenda\/\">Summit<\/a>, I&#8217;ve decided to do a push for docs for Cactus with <del datetime=\"2011-04-05T15:23:45+00:00\">a single<\/del> two dedicated doc days this Wednesday, April 6th, and Wednesday, April 13th. I&#8217;d like to get us all on the same page with this post. (Ha, page.) <\/p>\n<p>I track my doc tasks with a bunch of Post-it notes on my white board, and I&#8217;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.<\/p>\n<a href=\"http:\/\/www.openstack.org\/blog\/wp-content\/uploads\/2011\/04\/doctaskboard.jpg\"><img loading=\"lazy\" class=\"size-medium wp-image-748 alignnone\" style=\"margin: 10px;\" title=\"OpenStack doc task board\" src=\"http:\/\/www.openstack.org\/blog\/wp-content\/uploads\/2011\/04\/doctaskboard-224x300.jpg\" alt=\"OpenStack doc task board\" width=\"224\" height=\"300\" srcset=\"https:\/\/www.openstack.org\/blog\/wp-content\/uploads\/2011\/04\/doctaskboard-224x300.jpg 224w, https:\/\/www.openstack.org\/blog\/wp-content\/uploads\/2011\/04\/doctaskboard-768x1028.jpg 768w, https:\/\/www.openstack.org\/blog\/wp-content\/uploads\/2011\/04\/doctaskboard-765x1024.jpg 765w, https:\/\/www.openstack.org\/blog\/wp-content\/uploads\/2011\/04\/doctaskboard.jpg 968w\" sizes=\"(max-width: 224px) 100vw, 224px\" \/><\/a>\n<h2>Scope<\/h2>\n<p>The priorities for Cactus were clearly on reference documentation for flags and the API for Compute, and for Object Storage, logging information. We&#8217;ve had great efforts here which are rolled into the openstack-manuals Launchpad project and automation surrounding flags is available in Nova.<\/p>\n<p>I&#8217;ve published a draft for the <a href=\"http:\/\/docs.openstack.org\/trunk\/openstack-compute-admin\/content\/\">Compute Admin Guide for Cactus<\/a> 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:<\/p>\n<ul>\n<li>Hypervisors (Xen, KVM, Hyper-V, VMWare)<\/li>\n<li>Networking (<a href=\"http:\/\/docs.openstack.org\/trunk\/openstack-compute-admin\/content\/ch_networking.html\">specifically, review this chapter<\/a>)<\/li>\n<li>AJAX console and VM Console<\/li>\n<li>Image uploading and converting using nova-manage<\/li>\n<li>Conceptual diagrams<\/li>\n<li>Any items from the <a href=\"http:\/\/wiki.openstack.org\/Documentation\/ToDo\">Documentation ToDo list<\/a><\/li>\n<\/ul>\n<h2>Target Audience<\/h2>\n<p>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.<\/p>\n<h2>Location<\/h2>\n<p>I&#8217;ll be in San Francisco at the headquarters-formerly-known-as-Anso HQ on Wednesday (update: 4\/13). We don&#8217;t have room for additional writers right now, though, but contact me if you&#8217;re up for a group dinner that evening.<\/p>\n<p>After a long day of writing and diagramming, we&#8217;ll need libations. I&#8217;ll post a place for a meetup in the Mission area of San Francisco once we determine a location.<\/p>\n<h2>Closing Haiku<\/h2>\n<p>And lastly, a haiku from Daniel Green, who wrote a <a href=\"http:\/\/blogs.atlassian.com\/news\/2010\/12\/what_a_fantastic_doc_sprint.html\">Doc Sprint haiku for Atlassian and won their doc sprint haiku contest<\/a>:<\/p>\n<blockquote><p>No time to eat now.<br \/>\nShould be writing more content.<br \/>\nToo late, never mind.<\/p><\/blockquote>\n","protected":false},"excerpt":{"rendered":"<p>Rather than having a doc sprint session at the upcoming Summit, I&#8217;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&#8217;d like to get us all on the same page with this post. (Ha, page.) I track my doc&#8230;  <a href=\"https:\/\/www.openstack.org\/blog\/dedicated-doc-day\/\" class=\"more-link\" title=\"Read Dedicated Doc Day\">Read more &raquo;<\/a><\/p>\n","protected":false},"author":6,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":[],"categories":[5,9],"tags":[25,12,153],"_links":{"self":[{"href":"https:\/\/www.openstack.org\/blog\/wp-json\/wp\/v2\/posts\/738"}],"collection":[{"href":"https:\/\/www.openstack.org\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.openstack.org\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.openstack.org\/blog\/wp-json\/wp\/v2\/users\/6"}],"replies":[{"embeddable":true,"href":"https:\/\/www.openstack.org\/blog\/wp-json\/wp\/v2\/comments?post=738"}],"version-history":[{"count":14,"href":"https:\/\/www.openstack.org\/blog\/wp-json\/wp\/v2\/posts\/738\/revisions"}],"predecessor-version":[{"id":760,"href":"https:\/\/www.openstack.org\/blog\/wp-json\/wp\/v2\/posts\/738\/revisions\/760"}],"wp:attachment":[{"href":"https:\/\/www.openstack.org\/blog\/wp-json\/wp\/v2\/media?parent=738"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.openstack.org\/blog\/wp-json\/wp\/v2\/categories?post=738"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.openstack.org\/blog\/wp-json\/wp\/v2\/tags?post=738"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}