[Openstack-docs] What's Up Doc? Jan 30 2013

Anne Gentle anne at openstack.org
Wed Jan 30 21:01:31 UTC 2013


Hi all -
Keeping to the topical nature of our lists, I'm going to post these to the
openstack-docs list from now on. Forward to your friends and neighbors!

I don't know if I say this often enough, but it is truly an honor to work
with such high-caliber technical people on OpenStack. Thank you all for
your efforts.

1. In review and merged this past week:
Lots of new additions in the last few weeks:
>From Emilien, more info in the High Availability guide, including Keystone
HA, and updates to the Basic Install -- this guide gets a workout daily, I
think. Lots of bug fixes.
>From Tom and Lorin, tons of doc bug fixes, addressing doc comments, and
just plain good fixes.
Lorin has documented trusted compute pools and added a new chapter called
"Security Hardening" into the Compute Admin guide.
Lorin also is working on schema validation so our builds won't break due to
invalid DocBook getting into the repo.
Alan Pevec has addressed a few annoyances with glance add commands
lingering behind.
Eduardo Patrocinio has stuck it out with some fixes as well, thank you
Eduardo.

2. High priority doc work:
Tom has done a great job of tagging and triaging DocImpact items. I'd like
to start focusing on doc bugs where the Title starts with grizzly now that
we are nearing g-3 deadlines. As you may know, docs never really keep up
with code, but I'd like to make it a high priority.

Here are some general "features" going into Grizzly's Compute that people
will want docs for:
-Cells (Lorin has a WIP draft started)
-Database independence for Compute (get rid if nova-manage commands)
-Extension for retrieving secure password for guest servers
-Better block storage interface coverage
-Improvements to boot-from-volume (some of these are documented? She says
hopefully.)
-Bare metal provisioning (Do any docs exist?)
-Any new filters (I don't think AggregateMultiTenancyIsolation scheduler
filter is documented?)

3. Doc work going on that I know of:
Our intern Laura Alves has been doing a great job with API doc bugs. And by
great, I mean, fantastic. She's tracking with a spreadsheet [1] if you'd
like to see how much progress she's making on the Compute API and all its
extensions.

I've also seen results from the OpenStack documentation jam at LCA, the
Australian Linux Conf. [2] Tom has logged these four bugs to track their
impressions. Since you only get to look at something for the first time
once, these are valuable items I'd like to tackle:
1110135 "getting started" link on openstack.org is confusing for new users
1110136 installing openstack walkthrough doesn't let you know where to go
1110137 "running openstack" guide is exhausting to the point of being past
useful
1110146 docs.openstack.org "API" should be "using openstack"

4. New incoming doc requests:
The DNS project (moniker) team would like to get their API spec into the
docs system, and are investigating the typical build process.

5. Doc tools updates:
I'm testing 1.7.1-SNAPSHOT as it has some fixes for the PDF file naming
that we need, but it doesn't yet have the directory naming that we need, so
work continues. I did a mockup of a navigation menu for the long API
reference listing and attached it to the bug requesting navigation for that
page. [3]

6. Other doc news:
Still gathering snippets for the Operator's manual sprint at the end of
February. We'll be trying out a different authoring tool, "booki" through
sourcefabric.org for the sprint itself. We'll bring it all into our normal
toolset after the sprint.

1.
https://docs.google.com/spreadsheet/ccc?key=0AlbmThWRMTApdEQ2dUcyNGNjVVNtaWI3bWJsRkdMbVE#gid=0

2. https://lca2013.linux.org.au/wiki/OpenStack_Documentation_Jam_Session

3. https://bugs.launchpad.net/openstack-api-site/+bug/980228
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20130130/d1de7a4d/attachment.html>


More information about the Openstack-docs mailing list