Re: [openstack-dev] [doc] [api] Vision and changes for OpenStack API Guides

[Jay Pipes]

On 01/08/2016 04:39 PM, Anne Gentle wrote:

Hi all,

With milestone 2 coming next week I want to have a chat about API
guides, API reference information, and the
http://developer.openstack.org site. We have a new tool, fairy-slipper
[1], yep you read that right, that can migrate files from WADL to
Swagger as well as serve up reference info. We also have new build jobs
that can build API guides right from your projects repo to
developer.openstack.org .

There's a lot going on, so I've got an agenda item for next week to hold
a cross-project meeting so that you can send a team representative to
get the scoop on API guides and bring it back to your teams. I've
fielded great questions from a few teams, and want to ensure everyone's
in the loop.

A pair of specs set the stage for this work, feel free to review these
in advance of the meeting and come with questions. [2] [3]


Awesome specs and I love everything in both of those.

The one question I have is specifically around API microversions. Has 
the doc team had any ideas on how to handle the publication of 
microversion improvements to the API docs? I'm thinking something like 
"New in 2.18!"-like stuff would be really useful for API users.


Best,
-jay

__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

Re: [openstack-dev] [doc] [api] Vision and changes for OpenStack API Guides

[Anne Gentle]

On Fri, Jan 8, 2016 at 7:35 PM, Anne Gentle 
wrote:

>
>
> On Fri, Jan 8, 2016 at 3:39 PM, Anne Gentle  > wrote:
>
>> Hi all,
>>
>> With milestone 2 coming next week I want to have a chat about API guides,
>> API reference information, and the http://developer.openstack.org site.
>> We have a new tool, fairy-slipper [1], yep you read that right, that can
>> migrate files from WADL to Swagger as well as serve up reference info. We
>> also have new build jobs that can build API guides right from your projects
>> repo to developer.openstack.org.
>>
>> There's a lot going on, so I've got an agenda item for next week to hold
>> a cross-project meeting so that you can send a team representative to get
>> the scoop on API guides and bring it back to your teams. I've fielded great
>> questions from a few teams, and want to ensure everyone's in the loop.
>>
>> A pair of specs set the stage for this work, feel free to review these in
>> advance of the meeting and come with questions. [2] [3]
>>
>> Join me next week at the first pop-up Cross Project meeting, Tuesday at
>> 1700, in #openstack-meeting-cp. Feel free to add to the agenda at
>>
>
>
Double whoops, I mean Tuesday at 2100.
Anne


> Woops, agenda here:
>
>
> https://wiki.openstack.org/wiki/Meetings/CrossProjectMeeting#Proposed_agenda
>
>
>
>>
>> Thanks,
>> Anne
>>
>>
>> 1. https://github.com/openstack/fairy-slipper
>> 2. mitaka spec:
>> http://specs.openstack.org/openstack/docs-specs/specs/mitaka/app-guides-mitaka-vision.html
>> 3. liberty spec:
>> http://specs.openstack.org/openstack/docs-specs/specs/liberty/api-site.html
>>
>> --
>> Anne Gentle
>> Rackspace
>> Principal Engineer
>> www.justwriteclick.com
>>
>
>
>
> --
> Anne Gentle
> Rackspace
> Principal Engineer
> www.justwriteclick.com
>



-- 
Anne Gentle
Rackspace
Principal Engineer
www.justwriteclick.com
__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

Re: [openstack-dev] [doc] [api] Vision and changes for OpenStack API Guides

[Anne Gentle]

On Fri, Jan 8, 2016 at 3:39 PM, Anne Gentle 
wrote:

> Hi all,
>
> With milestone 2 coming next week I want to have a chat about API guides,
> API reference information, and the http://developer.openstack.org site.
> We have a new tool, fairy-slipper [1], yep you read that right, that can
> migrate files from WADL to Swagger as well as serve up reference info. We
> also have new build jobs that can build API guides right from your projects
> repo to developer.openstack.org.
>
> There's a lot going on, so I've got an agenda item for next week to hold a
> cross-project meeting so that you can send a team representative to get the
> scoop on API guides and bring it back to your teams. I've fielded great
> questions from a few teams, and want to ensure everyone's in the loop.
>
> A pair of specs set the stage for this work, feel free to review these in
> advance of the meeting and come with questions. [2] [3]
>
> Join me next week at the first pop-up Cross Project meeting, Tuesday at
> 1700, in #openstack-meeting-cp. Feel free to add to the agenda at
>

Woops, agenda here:

https://wiki.openstack.org/wiki/Meetings/CrossProjectMeeting#Proposed_agenda



>
> Thanks,
> Anne
>
>
> 1. https://github.com/openstack/fairy-slipper
> 2. mitaka spec:
> http://specs.openstack.org/openstack/docs-specs/specs/mitaka/app-guides-mitaka-vision.html
> 3. liberty spec:
> http://specs.openstack.org/openstack/docs-specs/specs/liberty/api-site.html
>
> --
> Anne Gentle
> Rackspace
> Principal Engineer
> www.justwriteclick.com
>



-- 
Anne Gentle
Rackspace
Principal Engineer
www.justwriteclick.com
__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

Re: [openstack-dev] [doc] [api] Vision and changes for OpenStack API Guides

[michael mccune]

On 01/08/2016 04:39 PM, Anne Gentle wrote:

Join me next week at the first pop-up Cross Project meeting, Tuesday at
1700, in #openstack-meeting-cp. Feel free to add to the agenda at


i'll definitely be there Anne, i'm very curious about this topic but 
sadly have not had the extra cycles to commit to it.


regards,
mike


__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev