openstack team mailing list archive

[Anne Gentle <anne@xxxxxxxxxxxxx>]

Wow, we went from 34 High folsom-targeted doc bugs two weeks ago to 17
on Monday. Great work everyone. I think there might be something to
this community documentation thing. :-P Tom Fifield and Ying Chun Guo
(Daisy) are tearing it up with reviews and patches!

Still over 100 doc bugs (some are tasks) to be worked. Here's the
summary for this week.

1. In review and merged this past week:
Object Storage API dev guide now contains object versioning and static
web information.
Add swift name_check filter to docs.
Add retry host cost weight function to scheduler docs.
Remove ArchFilter, adds ImagePropertiesFilter.
Extended section on overloading ldap attrs.
Add GET (show) to OS API keypairs extension docs.
Add the network association api docs.
Add Network creation to OS API docs.

Reviews still needed:
The Compute extensions for createBackup, os-migrateLive, and
os-resetState api for api.openstack.org.
https://review.openstack.org/#/c/12857/
The CLI user guide has been updated with Quantum information.
https://review.openstack.org/#/c/12851/
A glossary has been added that now builds properly.
https://review.openstack.org/#/c/12707/

2. High priority doc work:
Please pick up a bug from this list:
https://launchpad.net/openstack-manuals/+milestone/folsom

I'd like to get the tested samples that are going into nova into
the api.openstack.org site, can someone help with that?

Quantum is working diligently on their API guide and Admin guide so
you can install and run Quantum. Sounds like lots of people want this,
I'd like the focus on the official docs, but unoffficial docs are fine
too of course.

3. Doc work going on that I know of:
I'm working on new landing pages and navigation for the docs and api
sites. Please take a look at https://review.openstack.org/#/c/11232/
to see the work in progress.
David Hendler is working with John Griffith to finalize a Volume API
developer guide (a spec, more or less).
Bug fixes and more bug fixes. We're still at 111 doc bugs, all have
been reviewed and triaged, so jump in.

4. New incoming doc requests:
Need help with https://review.openstack.org/#/c/12214/ on the CI
puppet scripts to get the Image API 2.0 draft published.

5. Doc tools updates:
Think these are the doc tools bugs that the tools team is working on
this sprint:
http://bit.ly/Q9eGsu

6. Other doc news:
We've got two proposals for the Documentation Track at the Design
Summit and I'd like more! Please propose at
http://summit.openstack.org.

I've done a summary spreadsheet of what API docs live where at
https://docs.google.com/a/justwriteclick.com/spreadsheet/ccc?key=0Ar7TiePyvTNVdFhGVTZCSzRQQzJCYWtNZnZXblV6aUE#gid=0
titled OpenStack API Docs - What lives where? It should be a good
reference for which specs have what types of information (WADL? XSD?
DocBook? Markdown? RST?) all answers are here.

We met this week for our monthly doc meeting.
Summary: http://eavesdrop.openstack.org/meetings/doc_web_meeting/2012/doc_web_meeting.2012-09-10-20.01.html

Meeting Log: http://eavesdrop.openstack.org/meetings/doc_web_meeting/2012/doc_web_meeting.2012-09-10-20.01.log.html

Thanks,
Anne