[OpenStack-docs] [api] displaying useful docs from Swagger files

Anne Gentle annegentle at justwriteclick.com
Thu Feb 25 17:38:39 UTC 2016


On Wed, Feb 24, 2016 at 9:53 AM, Michael Krotscheck <krotscheck at gmail.com>
wrote:

> Personally, I'm a fan of anything that removes the need to render HTML on
> the server. Static HTML is a great start.
>

Why is that a stated preference? Truly curious.


>
> I have some tactical questions about the shipping needs of fairy slipper-
> how's it packaged, how's it built, etc? I notice that it's a munged
> python/javascript project, which goes against the best practices in the
> Project Team Guide - is there some effort to separate the two?
>
>
Since it's a dual-purpose tool (both migration and display) then yes, it's
a bit conflated. Do you have suggestions for what to do to properly
separate? Maybe I should meet with you next week to make sure I understand.
Can we chat on IRC early next week?

Anne


> Michael
>
> On Tue, Feb 23, 2016 at 1:37 PM michael mccune <msm at redhat.com> wrote:
>
>> On 02/23/2016 11:49 AM, Anne Gentle wrote:
>> > As an idea of what I would consider "code complete" for the migration:
>> > 1. All services WADL files migrate without any errors in the
>> > gate-build-swagger
>> > <
>> http://logs.openstack.org/57/281657/1/check/gate-build-swagger/993145e/>
>> job.
>> > Currently the Networking API files have the most errors and the team is
>> > looking into it. I've been logging bugs when the tool finds errors when
>> > migrating WADL.
>> > 2. All current HTML pages on developer.openstack.org/api-ref.html
>> > <http://developer.openstack.org/api-ref.html> can be redirected.
>>
>> this sounds reasonable to me.
>>
>> >
>> > However, defining "good enough" for the fairy-slipper display and
>> > interaction piece is more complex. So I believe an interim solution that
>> > migrates the WADL and gets off of WADL and clouddocs-maven-plugin for
>> > builds is a good way forward.
>> >
>> > What do you all think? Karen, Russell, and Mike McCune I'd definitely
>> > like your input.
>>
>> i like this as an interim solution. getting the swagger converted to
>> flat html which can be display will at least get us closer to the
>> ultimate goal.
>>
>> thanks for all the work on this Anne!
>>
>> regards,
>> mike
>>
>> _______________________________________________
>> OpenStack-docs mailing list
>> OpenStack-docs at lists.openstack.org
>> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>>
>
> _______________________________________________
> OpenStack-docs mailing list
> OpenStack-docs at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>
>


-- 
Anne Gentle
Rackspace
Principal Engineer
www.justwriteclick.com
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20160225/0b4b2b8e/attachment.html>


More information about the OpenStack-docs mailing list