
<html><head><meta http-equiv="Content-Type" content="text/html charset=gb2312"></head><body style="word-wrap: break-word; -webkit-nbsp-mode: space; -webkit-line-break: after-white-space;" class=""><br class=""><div><blockquote type="cite" class=""><div class="">在 2015年8月21日，上午9:48，Anne Gentle <<a href="mailto:annegentle@justwriteclick.com" class="">annegentle@justwriteclick.com</a>> 写道：</div><br class="Apple-interchange-newline"><div class=""><meta http-equiv="Content-Type" content="text/html; charset=utf-8" class=""><div dir="ltr" class="">Hi all, <div class="">A couple of notes for API docs this week. One is, the spec to enable RST builds to <a href="http://developer.openstack.org/api-guide/" class="">developer.openstack.org/api-guide/</a><service> merged. The plan is completely documented here: </div><div class=""><a href="http://specs.openstack.org/openstack/docs-specs/specs/liberty/api-site.html" class="">http://specs.openstack.org/openstack/docs-specs/specs/liberty/api-site.html</a><br class=""></div><div class=""><br class=""></div><div class="">I'm trying to work through the best way to build those while still working with Russell Sim on the WADL to Swagger converter at fairy-slipper:</div><div class=""><a href="https://github.com/russell/fairy-slipper" class="">https://github.com/russell/fairy-slipper</a><br class=""></div><div class=""><br class=""></div><div class="">Basically run migrate.sh and then run_server.sh to see what Swagger can look like when published (very rough). I'm fixing errors found in the WADL with migrate.sh as we go and hopefully we can start maintaining Swagger only before October. </div><div class="">He's working on Issues #4 and #10 but all others are up for grabs: <br clear="all" class=""><div class=""><a href="https://github.com/russell/fairy-slipper/issues" class="">https://github.com/russell/fairy-slipper/issues</a><br class=""></div></div><div class=""><br class=""></div><div class="">Then, next release we can use our baseline Swagger to ensure the docs get updated either automatically or manually. If your project already uses Pecan you may be able to write Swagger with this <a href="https://github.com/elmiko/pecan-swagger" class="">https://github.com/elmiko/pecan-swagger</a>.</div><div class=""><br class=""></div><div class=""><div class="">Some have noted these aren't in the OpenStack git namespace but right now, the publishing outcome is more important than the governance so we'll get there when needed. </div><div class=""><br class=""></div><div class="">I'll also put in a formal request here for the infrastructure team to let us know how to request a server that can serve content on <a href="http://developer.openstack.org/" class="">developer.openstack.org</a> rather than Cloud Sites. I'll attend the Infra team meeting next week and I've added it to the agenda.</div><div class=""><div class=""><a href="https://wiki.openstack.org/wiki/Meetings/InfraTeamMeeting#Agenda_for_next_meeting" class="">https://wiki.openstack.org/wiki/Meetings/InfraTeamMeeting#Agenda_for_next_meeting</a></div></div><div class=""><br class=""></div><div class="">Final note, I've written a set of API docs guidelines in the API Working Group repository. Please review and offer input, since this guidance applies for all OpenStack APIs. <a href="https://review.openstack.org/#/c/214817/" class="">https://review.openstack.org/#/c/214817/</a></div><div class=""><br class=""></div><div class="">In summary:</div><div class=""> - Please keep the WADL updated for now and continue to fix WADL bugs.</div><div class=""> - Take a look at fairy-slipper for the migration and pecan-swagger for generation.</div><div class=""> - Review the API docs guidelines and ask questions.<br class=""></div><div class=""> - With less than 2 months until release, let's git 'er done.</div></div></div></div></blockquote><div><br class=""></div><div>Thanks for the summary!</div><br class=""><blockquote type="cite" class=""><div class=""><div dir="ltr" class=""><div class=""><div class=""><br class=""></div><div class="">Thanks,</div><div class="">Anne</div><div class=""><br class=""></div>-- <br class=""><div class="gmail_signature"><div dir="ltr" class=""><div class="">Anne Gentle</div><div class="">Rackspace</div><div class="">Principal Engineer</div><div class=""><a href="http://www.justwriteclick.com/" target="_blank" class="">www.justwriteclick.com</a></div></div></div>

</div></div>

__________________________________________________________________________<br class="">OpenStack Development Mailing List (not for usage questions)<br class="">Unsubscribe: <a href="mailto:OpenStack-dev-request@lists.openstack.org" class="">OpenStack-dev-request@lists.openstack.org</a>?subject:unsubscribe<br class=""><a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev" class="">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev</a><br class=""></div></blockquote></div><br class=""></body></html>