[openstack-dev] [nova] Nova API improvement plan

Sean Dague sean at dague.net
Tue Aug 4 12:48:25 UTC 2015


On the plane home from the Nova midcycle meetup I spent a chunk of time
reading our API docs that are now in tree:
https://github.com/openstack/nova/blob/master/doc/source/v2/2.0_server_concepts.rst
and it got me concerned that documentation improvements don't seem to be
the top priority on the API infrastructure side.

The API concept guide is a really useful (though currently horribly out
of date) document for someone trying to use the Nova API without reading
all the Nova code. I feel like without that kind of big picture view,
the Nova API is quite hard to sort out.

I'd like to get updating that much higher up the priority list for the
API subteam. I realize there is this large json home patch series out
there to add new hotness to the API, but I feel like json home is
premature until we've got a concept picture of the Nova API in
documentation.

How do we get this ball rolling? Who's up for helping? How do we get the
concept guide back onto developer.openstack.org once it's not horribly
out of date?

I don't feel like I've got a plan yet in my head, but I'd really like to
get one developed over the next couple of weeks so that we can actually
make some real progress here. So who is up for helping, and what format
this plan will take, are the key bits.

	-Sean

-- 
Sean Dague
http://dague.net



More information about the OpenStack-dev mailing list