{"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\" decoding=\"async\" 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=\"auto, (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":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[5,9],"tags":[25,12,153],"class_list":["post-738","post","type-post","status-publish","format-standard","hentry","category-documentation","category-event","tag-documentation-2","tag-openstack","tag-writing"],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v28.5 - https:\/\/yoast.com\/product\/yoast-seo-wordpress\/ -->\n<title>Dedicated Doc Day - OpenStack Blog | Open Infrastructure Foundation<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/www.openstack.org\/blog\/dedicated-doc-day\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Dedicated Doc Day - OpenStack Blog | Open Infrastructure Foundation\" \/>\n<meta property=\"og:description\" content=\"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... Read more &raquo;\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.openstack.org\/blog\/dedicated-doc-day\/\" \/>\n<meta property=\"og:site_name\" content=\"OpenStack Blog | Open Infrastructure Foundation\" \/>\n<meta property=\"article:published_time\" content=\"2011-04-04T16:13:22+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2011-04-05T15:25:20+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/www.openstack.org\/blog\/wp-content\/uploads\/2011\/04\/doctaskboard.jpg\" \/>\n\t<meta property=\"og:image:width\" content=\"968\" \/>\n\t<meta property=\"og:image:height\" content=\"1296\" \/>\n\t<meta property=\"og:image:type\" content=\"image\/jpeg\" \/>\n<meta name=\"author\" content=\"Anne Gentle\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Anne Gentle\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"2 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\\\/\\\/www.openstack.org\\\/blog\\\/dedicated-doc-day\\\/#article\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/www.openstack.org\\\/blog\\\/dedicated-doc-day\\\/\"},\"author\":{\"name\":\"Anne Gentle\",\"@id\":\"https:\\\/\\\/www.openstack.org\\\/blog\\\/#\\\/schema\\\/person\\\/d7d9976c26c28e1df636f0549ed92fe9\"},\"headline\":\"Dedicated Doc Day\",\"datePublished\":\"2011-04-04T16:13:22+00:00\",\"dateModified\":\"2011-04-05T15:25:20+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\\\/\\\/www.openstack.org\\\/blog\\\/dedicated-doc-day\\\/\"},\"wordCount\":376,\"image\":{\"@id\":\"https:\\\/\\\/www.openstack.org\\\/blog\\\/dedicated-doc-day\\\/#primaryimage\"},\"thumbnailUrl\":\"http:\\\/\\\/www.openstack.org\\\/blog\\\/wp-content\\\/uploads\\\/2011\\\/04\\\/doctaskboard-224x300.jpg\",\"keywords\":[\"documentation\",\"OpenStack\",\"writing\"],\"articleSection\":[\"Documentation\",\"Event\"],\"inLanguage\":\"en-US\"},{\"@type\":\"WebPage\",\"@id\":\"https:\\\/\\\/www.openstack.org\\\/blog\\\/dedicated-doc-day\\\/\",\"url\":\"https:\\\/\\\/www.openstack.org\\\/blog\\\/dedicated-doc-day\\\/\",\"name\":\"Dedicated Doc Day - OpenStack Blog | Open Infrastructure Foundation\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/www.openstack.org\\\/blog\\\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\\\/\\\/www.openstack.org\\\/blog\\\/dedicated-doc-day\\\/#primaryimage\"},\"image\":{\"@id\":\"https:\\\/\\\/www.openstack.org\\\/blog\\\/dedicated-doc-day\\\/#primaryimage\"},\"thumbnailUrl\":\"http:\\\/\\\/www.openstack.org\\\/blog\\\/wp-content\\\/uploads\\\/2011\\\/04\\\/doctaskboard-224x300.jpg\",\"datePublished\":\"2011-04-04T16:13:22+00:00\",\"dateModified\":\"2011-04-05T15:25:20+00:00\",\"author\":{\"@id\":\"https:\\\/\\\/www.openstack.org\\\/blog\\\/#\\\/schema\\\/person\\\/d7d9976c26c28e1df636f0549ed92fe9\"},\"breadcrumb\":{\"@id\":\"https:\\\/\\\/www.openstack.org\\\/blog\\\/dedicated-doc-day\\\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/www.openstack.org\\\/blog\\\/dedicated-doc-day\\\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/www.openstack.org\\\/blog\\\/dedicated-doc-day\\\/#primaryimage\",\"url\":\"https:\\\/\\\/www.openstack.org\\\/blog\\\/wp-content\\\/uploads\\\/2011\\\/04\\\/doctaskboard.jpg\",\"contentUrl\":\"https:\\\/\\\/www.openstack.org\\\/blog\\\/wp-content\\\/uploads\\\/2011\\\/04\\\/doctaskboard.jpg\",\"width\":968,\"height\":1296,\"caption\":\"OpenStack doc task board\"},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/www.openstack.org\\\/blog\\\/dedicated-doc-day\\\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\\\/\\\/www.openstack.org\\\/blog\\\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Dedicated Doc Day\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\\\/\\\/www.openstack.org\\\/blog\\\/#website\",\"url\":\"https:\\\/\\\/www.openstack.org\\\/blog\\\/\",\"name\":\"OpenStack Blog | Open Infrastructure Foundation\",\"description\":\"The latest news and information for the OpenStack Community.\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\\\/\\\/www.openstack.org\\\/blog\\\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Person\",\"@id\":\"https:\\\/\\\/www.openstack.org\\\/blog\\\/#\\\/schema\\\/person\\\/d7d9976c26c28e1df636f0549ed92fe9\",\"name\":\"Anne Gentle\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/d36c925004feb55282d596e79f7bf1211101394b2ec4a029876ca286cbe1eca2?s=96&d=mm&r=g\",\"url\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/d36c925004feb55282d596e79f7bf1211101394b2ec4a029876ca286cbe1eca2?s=96&d=mm&r=g\",\"contentUrl\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/d36c925004feb55282d596e79f7bf1211101394b2ec4a029876ca286cbe1eca2?s=96&d=mm&r=g\",\"caption\":\"Anne Gentle\"},\"url\":\"https:\\\/\\\/www.openstack.org\\\/blog\\\/author\\\/annegentle\\\/\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Dedicated Doc Day - OpenStack Blog | Open Infrastructure Foundation","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/www.openstack.org\/blog\/dedicated-doc-day\/","og_locale":"en_US","og_type":"article","og_title":"Dedicated Doc Day - OpenStack Blog | Open Infrastructure Foundation","og_description":"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... Read more &raquo;","og_url":"https:\/\/www.openstack.org\/blog\/dedicated-doc-day\/","og_site_name":"OpenStack Blog | Open Infrastructure Foundation","article_published_time":"2011-04-04T16:13:22+00:00","article_modified_time":"2011-04-05T15:25:20+00:00","og_image":[{"width":968,"height":1296,"url":"https:\/\/www.openstack.org\/blog\/wp-content\/uploads\/2011\/04\/doctaskboard.jpg","type":"image\/jpeg"}],"author":"Anne Gentle","twitter_card":"summary_large_image","twitter_misc":{"Written by":"Anne Gentle","Est. reading time":"2 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/www.openstack.org\/blog\/dedicated-doc-day\/#article","isPartOf":{"@id":"https:\/\/www.openstack.org\/blog\/dedicated-doc-day\/"},"author":{"name":"Anne Gentle","@id":"https:\/\/www.openstack.org\/blog\/#\/schema\/person\/d7d9976c26c28e1df636f0549ed92fe9"},"headline":"Dedicated Doc Day","datePublished":"2011-04-04T16:13:22+00:00","dateModified":"2011-04-05T15:25:20+00:00","mainEntityOfPage":{"@id":"https:\/\/www.openstack.org\/blog\/dedicated-doc-day\/"},"wordCount":376,"image":{"@id":"https:\/\/www.openstack.org\/blog\/dedicated-doc-day\/#primaryimage"},"thumbnailUrl":"http:\/\/www.openstack.org\/blog\/wp-content\/uploads\/2011\/04\/doctaskboard-224x300.jpg","keywords":["documentation","OpenStack","writing"],"articleSection":["Documentation","Event"],"inLanguage":"en-US"},{"@type":"WebPage","@id":"https:\/\/www.openstack.org\/blog\/dedicated-doc-day\/","url":"https:\/\/www.openstack.org\/blog\/dedicated-doc-day\/","name":"Dedicated Doc Day - OpenStack Blog | Open Infrastructure Foundation","isPartOf":{"@id":"https:\/\/www.openstack.org\/blog\/#website"},"primaryImageOfPage":{"@id":"https:\/\/www.openstack.org\/blog\/dedicated-doc-day\/#primaryimage"},"image":{"@id":"https:\/\/www.openstack.org\/blog\/dedicated-doc-day\/#primaryimage"},"thumbnailUrl":"http:\/\/www.openstack.org\/blog\/wp-content\/uploads\/2011\/04\/doctaskboard-224x300.jpg","datePublished":"2011-04-04T16:13:22+00:00","dateModified":"2011-04-05T15:25:20+00:00","author":{"@id":"https:\/\/www.openstack.org\/blog\/#\/schema\/person\/d7d9976c26c28e1df636f0549ed92fe9"},"breadcrumb":{"@id":"https:\/\/www.openstack.org\/blog\/dedicated-doc-day\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.openstack.org\/blog\/dedicated-doc-day\/"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/www.openstack.org\/blog\/dedicated-doc-day\/#primaryimage","url":"https:\/\/www.openstack.org\/blog\/wp-content\/uploads\/2011\/04\/doctaskboard.jpg","contentUrl":"https:\/\/www.openstack.org\/blog\/wp-content\/uploads\/2011\/04\/doctaskboard.jpg","width":968,"height":1296,"caption":"OpenStack doc task board"},{"@type":"BreadcrumbList","@id":"https:\/\/www.openstack.org\/blog\/dedicated-doc-day\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/www.openstack.org\/blog\/"},{"@type":"ListItem","position":2,"name":"Dedicated Doc Day"}]},{"@type":"WebSite","@id":"https:\/\/www.openstack.org\/blog\/#website","url":"https:\/\/www.openstack.org\/blog\/","name":"OpenStack Blog | Open Infrastructure Foundation","description":"The latest news and information for the OpenStack Community.","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/www.openstack.org\/blog\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Person","@id":"https:\/\/www.openstack.org\/blog\/#\/schema\/person\/d7d9976c26c28e1df636f0549ed92fe9","name":"Anne Gentle","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/secure.gravatar.com\/avatar\/d36c925004feb55282d596e79f7bf1211101394b2ec4a029876ca286cbe1eca2?s=96&d=mm&r=g","url":"https:\/\/secure.gravatar.com\/avatar\/d36c925004feb55282d596e79f7bf1211101394b2ec4a029876ca286cbe1eca2?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/d36c925004feb55282d596e79f7bf1211101394b2ec4a029876ca286cbe1eca2?s=96&d=mm&r=g","caption":"Anne Gentle"},"url":"https:\/\/www.openstack.org\/blog\/author\/annegentle\/"}]}},"_links":{"self":[{"href":"https:\/\/www.openstack.org\/blog\/wp-json\/wp\/v2\/posts\/738","targetHints":{"allow":["GET"]}}],"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}]}}