[OpenStack-docs] OpenStack-docs Digest, Vol 44, Issue 17

Karen Bradshaw kbhawkey at gmail.com
Wed Feb 24 14:49:21 UTC 2016


>
>
>> ---------- Forwarded message ----------
> From: michael mccune <msm at redhat.com>
> To: openstack-docs at lists.openstack.org
> Cc:
> Date: Tue, 23 Feb 2016 16:34:58 -0500
> Subject: Re: [OpenStack-docs] [api] displaying useful docs from Swagger
> files
> 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.
>

----- Do you plan to include, on developer.openstack.org, only services
that have been migrated from WADL/DocBook or additional services that may
have a valid swagger file?


>
>> 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.
>
> ----- Agreed.  I tried the node app that generates html files from swagger
files.  It would provide an immediate path to generate static html.
Thanks!
Karen


> 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
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20160224/af4d404a/attachment.html>


More information about the OpenStack-docs mailing list