<div dir="ltr">Hi Hongbin,<div><br></div><div>Thanks for asking. I'd like for teams to look for ways to innovate and integrate with the navigation as a good entry point for OpenAPI to become a standard for OpenStack to use. That said, we have to move forward and make progress. </div><div><br></div><div>Is Lars or anyone on the Magnum team interested in the web development work to integrate with the sidebar? See the work at <a href="https://review.openstack.org/#/c/329508">https://review.openstack.org/#/c/329508</a> and my comments on <a href="https://review.openstack.org/#/c/351800/">https://review.openstack.org/#/c/351800/</a> saying that I would like teams to integrate first to provide the best web experience for people consuming the docs.</div><div><br></div><div>Anne</div></div><div class="gmail_extra"><br><div class="gmail_quote">On Fri, Aug 12, 2016 at 4:43 PM, Hongbin Lu <span dir="ltr"><<a href="mailto:hongbin.lu@huawei.com" target="_blank">hongbin.lu@huawei.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">





<div lang="EN-CA" link="blue" vlink="purple">
<div>
<p class="MsoNormal"><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d">Hi team,<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d"><u></u> <u></u></span></p>
<p class="MsoNormal"><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d">As mentioned in the email below, Magnum are not using common tooling for generating API docs, so we are excluded from the common navigation of OpenStack API.
 I think we need to prioritize the work to fix it. BTW, I notice there is a WIP patch [1] for generating API docs by using Swagger. However, I am not sure if Swagger belongs to “common tooling” (docs team, please confirm).<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d"><u></u> <u></u></span></p>
<p class="MsoNormal"><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d">[1]
<a href="https://review.openstack.org/#/c/317368/" target="_blank">https://review.openstack.org/#<wbr>/c/317368/</a><u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d"><u></u> <u></u></span></p>
<p class="MsoNormal"><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d">Best regards,<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d">Hongbin<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d"><u></u> <u></u></span></p>
<div style="border:none;border-top:solid #b5c4df 1.0pt;padding:3.0pt 0cm 0cm 0cm">
<p class="MsoNormal"><b><span lang="EN-US" style="font-size:10.0pt;font-family:"Tahoma","sans-serif"">From:</span></b><span lang="EN-US" style="font-size:10.0pt;font-family:"Tahoma","sans-serif""> Anne Gentle [mailto:<a href="mailto:annegentle@justwriteclick.com" target="_blank">annegentle@<wbr>justwriteclick.com</a>]
<br>
<b>Sent:</b> August-10-16 3:50 PM<br>
<b>To:</b> OpenStack Development Mailing List; <a href="mailto:openstack-docs@lists.openstack.org" target="_blank">openstack-docs@lists.<wbr>openstack.org</a><br>
<b>Subject:</b> [openstack-dev] [api] [doc] API status report<u></u><u></u></span></p>
</div>
<p class="MsoNormal"><u></u> <u></u></p>
<div>
<p class="MsoNormal">Hi all, <u></u><u></u></p>
<div>
<p class="MsoNormal">I wanted to report on status and answer any questions you all have about the API reference and guide publishing process.<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
<div>
<p class="MsoNormal">The expectation is that we provide all OpenStack API information on
<a href="http://developer.openstack.org" target="_blank">developer.openstack.org</a>. In order to meet that goal, it's simplest for now to have all projects use the RST+YAML+openstackdocstheme+<wbr>os-api-ref extension tooling so that users see available OpenStack APIs in a sidebar
 navigation drop-down list. <u></u><u></u></p>
</div>
<div>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
<div>
<p class="MsoNormal">--Migration--<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal">The current status for migration is that all WADL content is migrated except for trove. There is a patch in progress and I'm in contact with the team to assist in any way. <a href="https://review.openstack.org/#/c/316381/" target="_blank">https://review.openstack.<wbr>org/#/c/316381/</a><u></u><u></u></p>
</div>
<div>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
<div>
<p class="MsoNormal">--Theme, extension, release requirements--<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal">The current status for the theme, navigation, and Sphinx extension tooling is contained in the latest post from Graham proposing a solution for the release number switchover and offers to help teams as needed:
<a href="http://lists.openstack.org/pipermail/openstack-dev/2016-August/101112.html" target="_blank">
http://lists.openstack.org/<wbr>pipermail/openstack-dev/2016-<wbr>August/101112.html</a> I hope to meet the requirements deadline to get those changes landed. Requirements freeze is Aug 29.<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
<div>
<p class="MsoNormal">--Project coverage--<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal">The current status for project coverage is that these projects are now using the RST+YAML in-tree workflow and tools and publishing to
<a href="http://developer.openstack.org/api-ref/" target="_blank">http://developer.openstack.<wbr>org/api-ref/</a><servicename> so they will be included in the upcoming API navigation sidebar intended to span all OpenStack APIs:<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
<p class="MsoNormal">designate <a href="http://developer.openstack.org/api-ref/dns/" target="_blank">http://developer.<wbr>openstack.org/api-ref/dns/</a><u></u><u></u></p>
<div>
<p class="MsoNormal">glance <a href="http://developer.openstack.org/api-ref/image/" target="_blank">http://developer.<wbr>openstack.org/api-ref/image/</a><br>
heat <a href="http://developer.openstack.org/api-ref/orchestration/" target="_blank">http://developer.<wbr>openstack.org/api-ref/<wbr>orchestration/</a><br>
ironic <a href="http://developer.openstack.org/api-ref/baremetal/" target="_blank">http://developer.<wbr>openstack.org/api-ref/<wbr>baremetal/</a><br>
keystone <a href="http://developer.openstack.org/api-ref/identity/" target="_blank">http://developer.<wbr>openstack.org/api-ref/<wbr>identity/</a><br>
manila <a href="http://developer.openstack.org/api-ref/shared-file-systems/" target="_blank">http://developer.<wbr>openstack.org/api-ref/shared-<wbr>file-systems/</a><br>
neutron-lib <a href="http://developer.openstack.org/api-ref/networking/" target="_blank">http://developer.<wbr>openstack.org/api-ref/<wbr>networking/</a><br>
nova <a href="http://developer.openstack.org/api-ref/compute/" target="_blank">http://developer.openstack.<wbr>org/api-ref/compute/</a><br>
sahara <a href="http://developer.openstack.org/api-ref/data-processing/" target="_blank">http://developer.<wbr>openstack.org/api-ref/data-<wbr>processing/</a><br>
senlin <a href="http://developer.openstack.org/api-ref/clustering/" target="_blank">http://developer.<wbr>openstack.org/api-ref/<wbr>clustering/</a><br>
swift <a href="http://developer.openstack.org/api-ref/object-storage/" target="_blank">http://developer.<wbr>openstack.org/api-ref/object-<wbr>storage/</a><br>
zaqar <a href="http://developer.openstack.org/api-ref/messaging/" target="_blank">http://developer.<wbr>openstack.org/api-ref/<wbr>messaging/</a><u></u><u></u></p>
</div>
<div>
<div>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
<div>
<p class="MsoNormal">These projects are using the in-tree workflow and common tools, but do not have a publish job in project-config in the jenkins/jobs/projects.yaml file.<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
<div>
<p class="MsoNormal">ceilometer<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
<div>
<p class="MsoNormal">--Projects not using common tooling--<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal">These projects have API docs but are not yet using the common tooling, as far as I can tell. Because of the user experience, I'm making a judgement call that these cannot be included in the common navigation. I have patched the projects.yaml
 file in the governance repo with the URLs I could screen-scrape, but if I'm incorrect please do patch the projects.yaml in the governance repo.<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
<div>
<div>
<p class="MsoNormal">astara<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal">cloudkitty<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal">congress<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal">magnum<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal">mistral<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal">monasca<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal">solum<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal">tacker<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal">trove<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
<div>
<p class="MsoNormal">Please reach out if you have questions or need assistance getting started with the new common tooling, documented here: <a href="http://docs.openstack.org/contributor-guide/api-guides.html" target="_blank">http://docs.openstack.<wbr>org/contributor-guide/api-<wbr>guides.html</a>.<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
<div>
<p class="MsoNormal">For searchlight, looking at <a href="http://developer.openstack.org/api-ref/search/" target="_blank">
http://developer.openstack.<wbr>org/api-ref/search/</a> they have the build job, but the info is not complete yet. <u></u><u></u></p>
</div>
<div>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
<div>
<p class="MsoNormal">One additional project I'm not sure what to do with is networking-nfc, since I'm not sure it is considered a neutron API. Can I get help to sort that question out?<u></u><u></u></p>
</div>
<div>
<div>
<p class="MsoNormal"><br>
--Redirects from old pages--<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal">We have been adding .htaccess redirects from the old api-ref-servicename.html on
<a href="http://developer.openstack.org" target="_blank">developer.openstack.org</a> as teams are comfortable with the accuracy of information and build stability. Please help out by patching the api-site repository's .htaccess file when you are ready to redirect. These projects
 could be ready for redirects but do not have them:<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
<div>
<p class="MsoNormal">designate<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal">glance<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal">heat<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal">sahara<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal">senlin<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal">swift<u></u><u></u></p>
</div>
</div>
<div>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
<div>
<p class="MsoNormal">I'm available for questions so please reach out as needed. I hope this covers our current status.<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
<div>
<p class="MsoNormal">A million thank yous to everyone who got us this far! Great teamwork, great docs work, great UI work, and great API work everyone.<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal">Anne<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
<p class="MsoNormal">-- <u></u><u></u></p>
<div>
<div>
<div>
<div>
<div>
<p class="MsoNormal">Anne Gentle<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal"><a href="http://www.justwriteclick.com" target="_blank"><span style="font-size:9.5pt">www.justwriteclick.com</span></a><u></u><u></u></p>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>

<br>______________________________<wbr>_________________<br>
OpenStack-docs mailing list<br>
<a href="mailto:OpenStack-docs@lists.openstack.org">OpenStack-docs@lists.<wbr>openstack.org</a><br>
<a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs" rel="noreferrer" target="_blank">http://lists.openstack.org/<wbr>cgi-bin/mailman/listinfo/<wbr>openstack-docs</a><br>
<br></blockquote></div><br><br clear="all"><div><br></div>-- <br><div class="gmail_signature" data-smartmail="gmail_signature"><div dir="ltr"><div><div dir="ltr"><div>Anne Gentle</div><div><a href="http://www.justwriteclick.com" style="font-size:12.8px" target="_blank">www.justwriteclick.com</a><br></div></div></div></div></div>
</div>