openstack-poc team mailing list archive

[Jay Pipes <jaypipes@xxxxxxxxx>]

On Thu, Sep 8, 2011 at 3:33 AM, Ewan Mellor <Ewan.Mellor@xxxxxxxxxxxxx> wrote:
>> -----Original Message-----
>> From: Soren Hansen [mailto:soren@xxxxxxxxxxx]
>> Sent: 08 September 2011 00:28
>> To: Ewan Mellor
>> Cc: Thierry Carrez; openstack-poc@xxxxxxxxxxxxxxxxxxx
>> Subject: Re: [Openstack-poc] API compatibility
>>
>> 2011/9/8 Ewan Mellor <Ewan.Mellor@xxxxxxxxxxxxx>:
>> >> I think we should prepare to go home :) API gap bugs are regularly
>> >> added  to the bug tracker and I'm not really sure we are seeing the
>> end of
>> >> them.
>> > At some point, we might lose the race implementing code to match the
>> doc, and then we're going to have start taking stuff out of the doc to
>> match the code instead.  That's fine, it just needs us to be realistic
>> about how much we're going to get done between now and party day.
>>
>> I would by far prefer removing stuff from the docs. If there's
>> something in the docs that the code actually doesn't do, there's no
>> way it's going to be in a state ready for release before release date.
>>
>> I've lost track, though, of where this API doc lives now and who
>> "owns" it. Can we rip stuff out of it that doesn't match reality?
>
> We agreed on Tuesday -- PTLs own their APIs.  So it's up to Vish, John, and Jay where their docs live.

The Glance API docs will live here:

https://github.com/openstack/image-api

Anne and I will move the current documentation today from here:

http://bazaar.launchpad.net/~annegentle/openstack-manuals/trunk/files/head:/doc/source/docbkx/openstack-image-service-dev/

to the above location, and going forward, we will ensure that the RST
API documentation previously available here:

https://github.com/openstack/glance/blob/master/doc/source/glanceapi.rst

Will merge with the DocBookXML API documentation.

Cheers,
jay