{"id":5532,"date":"2014-01-03T09:48:06","date_gmt":"2014-01-03T15:48:06","guid":{"rendered":"http:\/\/www.openstack.org\/blog\/?p=5532"},"modified":"2014-01-03T09:48:06","modified_gmt":"2014-01-03T15:48:06","slug":"openstack-documentation-wrap-up-for-2013","status":"publish","type":"post","link":"https:\/\/www.openstack.org\/blog\/openstack-documentation-wrap-up-for-2013\/","title":{"rendered":"OpenStack Documentation Wrap Up for 2013"},"content":{"rendered":"<p class=\"lead\">It&#8217;s that time of the new year to reflect and look for ways to keep improving the OpenStack docs. Here&#8217;s a list of major events from 2013 in OpenStack doc-land. Let&#8217;s look at the year in review.<\/p>\n<ul>\n<li>Operator Guide book sprint was in February 2013 and I still remember it fondly. The <a href=\"http:\/\/www.openstack.org\/blog\/2013\/02\/bring-on-the-crazy-zero-to-book-in-five-days\/\" target=\"_blank\">before post<\/a> and the <a href=\"http:\/\/www.openstack.org\/blog\/2013\/03\/we-did-it-zero-to-book-in-five-days\/\" target=\"_blank\">after post<\/a> tell the tale, as does <a href=\"http:\/\/youtu.be\/lYfHEy6E2n0\">this video. <\/a><\/li>\n<li>Diane Fleming added a sidebar for navigating the every growing API reference site at <a href=\"http:\/\/api.openstack.org\/api-ref.html\" target=\"_blank\">http:\/\/api.openstack.org\/api-ref.html<\/a>. I&#8217;d like to see more improvements to the design for that page with more responsiveness for different devices.<\/li>\n<li>We have improved the DocImpact commit message flag, where developers can add DocImpact to a commit message, and some automation happens in the background to automatically log a doc bug, setting it to New until the patch actually merges, eliminating a lot of manual steps. Props to Tom Fifield and Steven Deaton for this accomplishment in 2013.<\/li>\n<li>We also were able to simultaneously release the docs with the code for the Havana release in the fall for the first time. A large part of this accomplishment is thanks to automation of the <a href=\"http:\/\/docs.openstack.org\/havana\/config-reference\/content\/\">Configuration Reference<\/a>, where the auto doc tool scrapes the docstrings and collects them into meaningful tables per feature per project.<\/li>\n<li>This year included a complete reorganization of the <a href=\"http:\/\/docs.openstack.org\">docs.openstack.org<\/a> site landing page. We also added new titles to try to accommodate new audiences. We have a new user guide and admin user guide, which walk through both the Dashboard and command-line interface procedures to accomplish common tasks like launching an instance. As I mentioned above, we&#8217;re also maintaining a new Configuration Reference which lists all possible configuration options across multiple OpenStack projects.<\/li>\n<li>This year after the Summit in Portland, I worked with Lew Tucker&#8217;s finely tuned organization at Cisco to hire a contract writer dedicated to the upstream vanilla OpenStack install guide. There were still hiccups and delays despite having a dedicated resource, but the resulting install guide has been well-received.<\/li>\n<li>We held a mid-release <a href=\"http:\/\/justwriteclick.com\/2013\/09\/13\/openstack-docs-boot-camp-wrap-up\/\" target=\"_blank\">OpenStack Docs Boot Camp<\/a> in sunny California at the Mirantis office. We learned a lot from each other and got to know contributors we hadn&#8217;t met in person.<\/li>\n<li>In July 2013, the OpenStack security team put together a fantastic <a href=\"http:\/\/docs.openstack.org\/sec\/\" target=\"_blank\">OpenStack Security Guide<\/a> with a <a href=\"http:\/\/www.openstack.org\/blog\/2013\/07\/openstack-security-guide-now-available\/\" target=\"_blank\">book sprint<\/a> in an undisclosed location in Maryland. At least I think that&#8217;s where it was.They&#8217;re security conscious.<\/li>\n<li>The <a href=\"http:\/\/docs.openstack.org\/high-availability-guide\/content\/index.html\" target=\"_blank\">High Availability Guide<\/a> got some refreshing as well, thanks to Emilien Macchi and Enovance test labs.<\/li>\n<li>We have Japanese fonts now supported in our tool chain, with Japanese translations now available on <a href=\"http:\/\/docs.openstack.org\/ja\/\" target=\"_blank\">docs.openstack.org\/ja\/<\/a>. Much appreciation to the translation team, especially the Japanese team lead Masanori Itoh, I18N team lead Daisy Guo, and David Cramer for the doc tooling for the font support.<\/li>\n<li>Also in 2013 we have been incubating the open source training manuals team within the OpenStack Documentation program. They&#8217;ve produced an Associate Training Guide, with outlines and schedules for an Operator Training Guide, a Developer Training Guide, and an Architect Training Guide. All guides and outlines are available at <a href=\"http:\/\/docs.openstack.org\/training-guides\/content\/\" target=\"_blank\">http:\/\/docs.openstack.org\/training-guides\/content\/<\/a>.<\/li>\n<li>At the Summit in Hong Kong we announced that the <a href=\"http:\/\/www.openstack.org\/blog\/2013\/11\/openstack-operations-guide-now-an-oreilly-early-edition\/\" target=\"_blank\">OpenStack Operations Guide became an O&#8217;Reilly edition<\/a> and we are working on the edits coming back from our developmental editor.<\/li>\n<li>Most recently we had a Doc Bug Day on 12\/20\/13 squashing over 80 bugs, following the sun from Australia to the US west coast and then some.<\/li>\n<\/ul>\n<p>This past year OpenStack Documentation became an official program with me, Anne Gentle, elected as the Program Technical Lead. I hope to continue to serve and promote the Documentation efforts as we go into the new year. Yes, I do read the feedback from the user survey and I know we have work ahead of us. But for the docs to be second-most complained about instead of first-most was a moment to be celebrated in 2013. Thanks to the many contributors who make these incremental improvements happen.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>It&#8217;s that time of the new year to reflect and look for ways to keep improving the OpenStack docs. Here&#8217;s a list of major events from 2013 in OpenStack doc-land. Let&#8217;s look at the year in review. Operator Guide book sprint was in February 2013 and I still remember it fondly. The before post and&#8230;  <a href=\"https:\/\/www.openstack.org\/blog\/openstack-documentation-wrap-up-for-2013\/\" class=\"more-link\" title=\"Read OpenStack Documentation Wrap Up for 2013\">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":[3,5],"tags":[],"class_list":["post-5532","post","type-post","status-publish","format-standard","hentry","category-community","category-documentation"],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v28.6 - https:\/\/yoast.com\/product\/yoast-seo-wordpress\/ -->\n<title>OpenStack Documentation Wrap Up for 2013 - 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\/openstack-documentation-wrap-up-for-2013\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"OpenStack Documentation Wrap Up for 2013 - OpenStack Blog | Open Infrastructure Foundation\" \/>\n<meta property=\"og:description\" content=\"It&#8217;s that time of the new year to reflect and look for ways to keep improving the OpenStack docs. Here&#8217;s a list of major events from 2013 in OpenStack doc-land. Let&#8217;s look at the year in review. Operator Guide book sprint was in February 2013 and I still remember it fondly. The before post and... Read more &raquo;\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.openstack.org\/blog\/openstack-documentation-wrap-up-for-2013\/\" \/>\n<meta property=\"og:site_name\" content=\"OpenStack Blog | Open Infrastructure Foundation\" \/>\n<meta property=\"article:published_time\" content=\"2014-01-03T15:48:06+00:00\" \/>\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=\"3 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\\\/\\\/www.openstack.org\\\/blog\\\/openstack-documentation-wrap-up-for-2013\\\/#article\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/www.openstack.org\\\/blog\\\/openstack-documentation-wrap-up-for-2013\\\/\"},\"author\":{\"name\":\"Anne Gentle\",\"@id\":\"https:\\\/\\\/www.openstack.org\\\/blog\\\/#\\\/schema\\\/person\\\/d7d9976c26c28e1df636f0549ed92fe9\"},\"headline\":\"OpenStack Documentation Wrap Up for 2013\",\"datePublished\":\"2014-01-03T15:48:06+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\\\/\\\/www.openstack.org\\\/blog\\\/openstack-documentation-wrap-up-for-2013\\\/\"},\"wordCount\":679,\"articleSection\":[\"community\",\"Documentation\"],\"inLanguage\":\"en-US\"},{\"@type\":\"WebPage\",\"@id\":\"https:\\\/\\\/www.openstack.org\\\/blog\\\/openstack-documentation-wrap-up-for-2013\\\/\",\"url\":\"https:\\\/\\\/www.openstack.org\\\/blog\\\/openstack-documentation-wrap-up-for-2013\\\/\",\"name\":\"OpenStack Documentation Wrap Up for 2013 - OpenStack Blog | Open Infrastructure Foundation\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/www.openstack.org\\\/blog\\\/#website\"},\"datePublished\":\"2014-01-03T15:48:06+00:00\",\"author\":{\"@id\":\"https:\\\/\\\/www.openstack.org\\\/blog\\\/#\\\/schema\\\/person\\\/d7d9976c26c28e1df636f0549ed92fe9\"},\"breadcrumb\":{\"@id\":\"https:\\\/\\\/www.openstack.org\\\/blog\\\/openstack-documentation-wrap-up-for-2013\\\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/www.openstack.org\\\/blog\\\/openstack-documentation-wrap-up-for-2013\\\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/www.openstack.org\\\/blog\\\/openstack-documentation-wrap-up-for-2013\\\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\\\/\\\/www.openstack.org\\\/blog\\\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"OpenStack Documentation Wrap Up for 2013\"}]},{\"@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":"OpenStack Documentation Wrap Up for 2013 - 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\/openstack-documentation-wrap-up-for-2013\/","og_locale":"en_US","og_type":"article","og_title":"OpenStack Documentation Wrap Up for 2013 - OpenStack Blog | Open Infrastructure Foundation","og_description":"It&#8217;s that time of the new year to reflect and look for ways to keep improving the OpenStack docs. Here&#8217;s a list of major events from 2013 in OpenStack doc-land. Let&#8217;s look at the year in review. Operator Guide book sprint was in February 2013 and I still remember it fondly. The before post and... Read more &raquo;","og_url":"https:\/\/www.openstack.org\/blog\/openstack-documentation-wrap-up-for-2013\/","og_site_name":"OpenStack Blog | Open Infrastructure Foundation","article_published_time":"2014-01-03T15:48:06+00:00","author":"Anne Gentle","twitter_card":"summary_large_image","twitter_misc":{"Written by":"Anne Gentle","Est. reading time":"3 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/www.openstack.org\/blog\/openstack-documentation-wrap-up-for-2013\/#article","isPartOf":{"@id":"https:\/\/www.openstack.org\/blog\/openstack-documentation-wrap-up-for-2013\/"},"author":{"name":"Anne Gentle","@id":"https:\/\/www.openstack.org\/blog\/#\/schema\/person\/d7d9976c26c28e1df636f0549ed92fe9"},"headline":"OpenStack Documentation Wrap Up for 2013","datePublished":"2014-01-03T15:48:06+00:00","mainEntityOfPage":{"@id":"https:\/\/www.openstack.org\/blog\/openstack-documentation-wrap-up-for-2013\/"},"wordCount":679,"articleSection":["community","Documentation"],"inLanguage":"en-US"},{"@type":"WebPage","@id":"https:\/\/www.openstack.org\/blog\/openstack-documentation-wrap-up-for-2013\/","url":"https:\/\/www.openstack.org\/blog\/openstack-documentation-wrap-up-for-2013\/","name":"OpenStack Documentation Wrap Up for 2013 - OpenStack Blog | Open Infrastructure Foundation","isPartOf":{"@id":"https:\/\/www.openstack.org\/blog\/#website"},"datePublished":"2014-01-03T15:48:06+00:00","author":{"@id":"https:\/\/www.openstack.org\/blog\/#\/schema\/person\/d7d9976c26c28e1df636f0549ed92fe9"},"breadcrumb":{"@id":"https:\/\/www.openstack.org\/blog\/openstack-documentation-wrap-up-for-2013\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.openstack.org\/blog\/openstack-documentation-wrap-up-for-2013\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/www.openstack.org\/blog\/openstack-documentation-wrap-up-for-2013\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/www.openstack.org\/blog\/"},{"@type":"ListItem","position":2,"name":"OpenStack Documentation Wrap Up for 2013"}]},{"@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\/5532","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=5532"}],"version-history":[{"count":4,"href":"https:\/\/www.openstack.org\/blog\/wp-json\/wp\/v2\/posts\/5532\/revisions"}],"predecessor-version":[{"id":5536,"href":"https:\/\/www.openstack.org\/blog\/wp-json\/wp\/v2\/posts\/5532\/revisions\/5536"}],"wp:attachment":[{"href":"https:\/\/www.openstack.org\/blog\/wp-json\/wp\/v2\/media?parent=5532"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.openstack.org\/blog\/wp-json\/wp\/v2\/categories?post=5532"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.openstack.org\/blog\/wp-json\/wp\/v2\/tags?post=5532"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}