Open Stack

On 10/29/2012 10:18 AM, Anne Gentle wrote:
<snip>
> Sure, great topic.
>
> So far, the work done is:
> - manually copy files from the nova repository api-samples folder into
> the openstack-manuals repository
> - point to the new api-samples in the relevant Core Compute-api WADL
> - put in this patch: https://review.openstack.org/#/c/13201/
>
> Then the work pattern is to propose patches for all the extension examples.
> - manually copy files from the nova repository
> - point to the new api-sample files in the relevant extension WADL
> - put in this patch: https://review.openstack.org/#/c/14362/
>
> The second work pattern needs to be repeated about 90 times to get all
> the Extension examples updated. I talked about it in the Summit doc
> session - would another discussion in the meeting help? Seems like we
> just need more workers on the task than anything. Though I can
> certainly do a detailed walkthrough for anyone who needs it.

Sadly there were just too many good and important design summit 
sessions, so I missed that one. :( My bad.

> I'd also like suggestions for automating the "manually copy files" step.

That's actually where I was most interested, Mauro and I were discussing 
this the other day. I guess one of the questions is can we make a commit 
hook that would do this automatically? Is there a verification step 
that's needed as part of this? Also, what's needed to expose not only 
success, but expected error codes as well?

I've specifically got interest in this as I try to make a sweep through 
our consistency issues (especially around return codes) for nova in the 
near term. Giving the api doc generation some love as part of this seems 
just natural.

It looks like the next doc meeting isn't for a while, so it might be 
nice to actually try to tackle ahead of time, either here, or in an 
impromtu irc gathering.

	-Sean

-- 
Sean Dague
IBM Linux Technology Center
email: sdague at linux.vnet.ibm.com
alt-email: sldague at us.ibm.com