Open Stack

On 12/09/13 22:40, Anne Gentle wrote:
> I'm happy to be back in Austin after Docs Boot Camp and working on all
> sorts of communications and follow up from a great event!
> 
> 1. In review and merged this past week:
> 
> The folder and book consolidation happened on Sunday and we're still
> doing clean up. Many thanks to Diane and Andreas and Tom for their work
> and reviews.
> 
> There are still topics that need to make their way into correct guides,
> tracked with
> bug https://bugs.launchpad.net/openstack-manuals/+bug/1223542. I'm going
> to take a first pass at it, and Summer Long will return to it when she
> gets back from a break.
> 
> 2. High priority doc work:
> 
> I know our bug backlog is still over 100. I'd like to encourage bug
> triaging as much as bug fixing, where you add comments to a bug
> indicating which files to change and wording to use. The knowledge and
> information can be hard to come by, so triaging and asking questions as
> you do so is a huge help. 
> 
> https://bugs.launchpad.net/openstack-manuals/+milestone/havana Use this
> list to find bugs to work on.
> 
> 3. Doc work going on that I know of:
> 
> I'd like to get an update on the Compute API v3 work - Kersten or Chris,
> how is that going? 
> 
> 4. New incoming doc requests:
> 
> At the Docs Boot Camp, Joe Gordon asked me to write a checklist of
> information that should be included with a DocImpact patch. I scribbled
> down some notes and I'll get them on the wiki:
> 
> - Why use the feature?
> 
> - Who would use the feature?
> 
> - What is the exact usage for the feature? For a CLI call, provide
> examples of all the parameters the patch includes.
> 
> - Does the feature also have permissions/policies attached?
> 
> - If it is a configuration option, which flag grouping should it go
> into? (Defaults and a description are already required by their gate
> test on nova.)

This looks good for new features. I'd also note that there are probably
situations which aren't features where DocImpact is needed, but I'm too
tired right now to think of any :)


> 5. Doc tools updates:
> 
> There is a 1.9.4-SNAPSHOT in testing now. It has bug fixes:
> 
> Fixed "Failed to load image" messages from DocBook xsls on stdout. (1193491)
> Fixed invalid css rules.
> Generate table from plain parameters when documenting requests/response
> and no longer suppress documentation related to code samples embedded
> with requests/responses in wadls.
> Show error codes in api-ref.html output. 
> 
> David Cramer also will start work on enhancing the output for HTML so
> that each page has a bug reporting
> button: https://bugs.launchpad.net/openstack-manuals/+bug/1223614.
> 
> 6. Other doc news:
> 
> We had a great time at Mirantis for boot camp. I'll post notes to my
> blog and update our wiki pages as needed. We should have videos posted
> in the next 1-2 weeks, and links to slides are on the wiki page at
> http://wiki.openstack.org/Docs_BootCamp2013. Thanks to all the teachers
> and learners.
> 
> 
> 
> _______________________________________________
> Openstack-docs mailing list
> Openstack-docs at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>