<html xmlns:v="urn:schemas-microsoft-com:vml" xmlns:o="urn:schemas-microsoft-com:office:office" xmlns:w="urn:schemas-microsoft-com:office:word" xmlns:m="http://schemas.microsoft.com/office/2004/12/omml" xmlns="http://www.w3.org/TR/REC-html40">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="Generator" content="Microsoft Word 12 (filtered medium)">
<style><!--
/* Font Definitions */
@font-face
{font-family:SimSun;
panose-1:2 1 6 0 3 1 1 1 1 1;}
@font-face
{font-family:"Cambria Math";
panose-1:2 4 5 3 5 4 6 3 2 4;}
@font-face
{font-family:Calibri;
panose-1:2 15 5 2 2 2 4 3 2 4;}
@font-face
{font-family:Tahoma;
panose-1:2 11 6 4 3 5 4 4 2 4;}
@font-face
{font-family:"\@SimSun";
panose-1:2 1 6 0 3 1 1 1 1 1;}
/* Style Definitions */
p.MsoNormal, li.MsoNormal, div.MsoNormal
{margin:0cm;
margin-bottom:.0001pt;
font-size:12.0pt;
font-family:"Times New Roman","serif";}
a:link, span.MsoHyperlink
{mso-style-priority:99;
color:blue;
text-decoration:underline;}
a:visited, span.MsoHyperlinkFollowed
{mso-style-priority:99;
color:purple;
text-decoration:underline;}
span.EmailStyle17
{mso-style-type:personal-reply;
font-family:"Calibri","sans-serif";
color:#1F497D;}
.MsoChpDefault
{mso-style-type:export-only;}
@page WordSection1
{size:612.0pt 792.0pt;
margin:72.0pt 72.0pt 72.0pt 72.0pt;}
div.WordSection1
{page:WordSection1;}
--></style><!--[if gte mso 9]><xml>
<o:shapedefaults v:ext="edit" spidmax="1026" />
</xml><![endif]--><!--[if gte mso 9]><xml>
<o:shapelayout v:ext="edit">
<o:idmap v:ext="edit" data="1" />
</o:shapelayout></xml><![endif]-->
</head>
<body lang="EN-CA" link="blue" vlink="purple">
<div class="WordSection1">
<p class="MsoNormal"><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1F497D">Hi team,<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1F497D"><o:p> </o:p></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).<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1F497D"><o:p> </o:p></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/">https://review.openstack.org/#/c/317368/</a><o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1F497D"><o:p> </o:p></span></p>
<p class="MsoNormal"><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1F497D">Best regards,<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1F497D">Hongbin<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1F497D"><o:p> </o:p></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:annegentle@justwriteclick.com]
<br>
<b>Sent:</b> August-10-16 3:50 PM<br>
<b>To:</b> OpenStack Development Mailing List; openstack-docs@lists.openstack.org<br>
<b>Subject:</b> [openstack-dev] [api] [doc] API status report<o:p></o:p></span></p>
</div>
<p class="MsoNormal"><o:p> </o:p></p>
<div>
<p class="MsoNormal">Hi all, <o:p></o:p></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.<o:p></o:p></p>
</div>
<div>
<p class="MsoNormal"><o:p> </o:p></p>
</div>
<div>
<p class="MsoNormal">The expectation is that we provide all OpenStack API information on
<a href="http://developer.openstack.org">developer.openstack.org</a>. In order to meet that goal, it's simplest for now to have all projects use the RST+YAML+openstackdocstheme+os-api-ref extension tooling so that users see available OpenStack APIs in a sidebar
navigation drop-down list. <o:p></o:p></p>
</div>
<div>
<p class="MsoNormal"><o:p> </o:p></p>
</div>
<div>
<p class="MsoNormal">--Migration--<o:p></o:p></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/">https://review.openstack.org/#/c/316381/</a><o:p></o:p></p>
</div>
<div>
<p class="MsoNormal"><o:p> </o:p></p>
</div>
<div>
<p class="MsoNormal">--Theme, extension, release requirements--<o:p></o:p></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">
http://lists.openstack.org/pipermail/openstack-dev/2016-August/101112.html</a> I hope to meet the requirements deadline to get those changes landed. Requirements freeze is Aug 29.<o:p></o:p></p>
</div>
<div>
<p class="MsoNormal"><o:p> </o:p></p>
</div>
<div>
<p class="MsoNormal">--Project coverage--<o:p></o:p></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/">http://developer.openstack.org/api-ref/</a><servicename> so they will be included in the upcoming API navigation sidebar intended to span all OpenStack APIs:<o:p></o:p></p>
</div>
<div>
<p class="MsoNormal"><o:p> </o:p></p>
</div>
<p class="MsoNormal">designate <a href="http://developer.openstack.org/api-ref/dns/">http://developer.openstack.org/api-ref/dns/</a><o:p></o:p></p>
<div>
<p class="MsoNormal">glance <a href="http://developer.openstack.org/api-ref/image/">http://developer.openstack.org/api-ref/image/</a><br>
heat <a href="http://developer.openstack.org/api-ref/orchestration/">http://developer.openstack.org/api-ref/orchestration/</a><br>
ironic <a href="http://developer.openstack.org/api-ref/baremetal/">http://developer.openstack.org/api-ref/baremetal/</a><br>
keystone <a href="http://developer.openstack.org/api-ref/identity/">http://developer.openstack.org/api-ref/identity/</a><br>
manila <a href="http://developer.openstack.org/api-ref/shared-file-systems/">http://developer.openstack.org/api-ref/shared-file-systems/</a><br>
neutron-lib <a href="http://developer.openstack.org/api-ref/networking/">http://developer.openstack.org/api-ref/networking/</a><br>
nova <a href="http://developer.openstack.org/api-ref/compute/">http://developer.openstack.org/api-ref/compute/</a><br>
sahara <a href="http://developer.openstack.org/api-ref/data-processing/">http://developer.openstack.org/api-ref/data-processing/</a><br>
senlin <a href="http://developer.openstack.org/api-ref/clustering/">http://developer.openstack.org/api-ref/clustering/</a><br>
swift <a href="http://developer.openstack.org/api-ref/object-storage/">http://developer.openstack.org/api-ref/object-storage/</a><br>
zaqar <a href="http://developer.openstack.org/api-ref/messaging/">http://developer.openstack.org/api-ref/messaging/</a><o:p></o:p></p>
</div>
<div>
<div>
<p class="MsoNormal"><o:p> </o:p></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.<o:p></o:p></p>
</div>
<div>
<p class="MsoNormal"><o:p> </o:p></p>
</div>
<div>
<p class="MsoNormal">ceilometer<o:p></o:p></p>
</div>
<div>
<p class="MsoNormal"><o:p> </o:p></p>
</div>
<div>
<p class="MsoNormal">--Projects not using common tooling--<o:p></o:p></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.<o:p></o:p></p>
</div>
<div>
<p class="MsoNormal"><o:p> </o:p></p>
</div>
<div>
<div>
<p class="MsoNormal">astara<o:p></o:p></p>
</div>
<div>
<p class="MsoNormal">cloudkitty<o:p></o:p></p>
</div>
<div>
<p class="MsoNormal">congress<o:p></o:p></p>
</div>
<div>
<p class="MsoNormal">magnum<o:p></o:p></p>
</div>
<div>
<p class="MsoNormal">mistral<o:p></o:p></p>
</div>
<div>
<p class="MsoNormal">monasca<o:p></o:p></p>
</div>
<div>
<p class="MsoNormal">solum<o:p></o:p></p>
</div>
<div>
<p class="MsoNormal">tacker<o:p></o:p></p>
</div>
<div>
<p class="MsoNormal">trove<o:p></o:p></p>
</div>
<div>
<p class="MsoNormal"><o:p> </o:p></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">http://docs.openstack.org/contributor-guide/api-guides.html</a>.<o:p></o:p></p>
</div>
<div>
<p class="MsoNormal"><o:p> </o:p></p>
</div>
<div>
<p class="MsoNormal">For searchlight, looking at <a href="http://developer.openstack.org/api-ref/search/">
http://developer.openstack.org/api-ref/search/</a> they have the build job, but the info is not complete yet. <o:p></o:p></p>
</div>
<div>
<p class="MsoNormal"><o:p> </o:p></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?<o:p></o:p></p>
</div>
<div>
<div>
<p class="MsoNormal"><br>
--Redirects from old pages--<o:p></o:p></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">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:<o:p></o:p></p>
</div>
<div>
<p class="MsoNormal"><o:p> </o:p></p>
</div>
<div>
<p class="MsoNormal">designate<o:p></o:p></p>
</div>
<div>
<p class="MsoNormal">glance<o:p></o:p></p>
</div>
<div>
<p class="MsoNormal">heat<o:p></o:p></p>
</div>
<div>
<p class="MsoNormal">sahara<o:p></o:p></p>
</div>
<div>
<p class="MsoNormal">senlin<o:p></o:p></p>
</div>
<div>
<p class="MsoNormal">swift<o:p></o:p></p>
</div>
</div>
<div>
<p class="MsoNormal"><o:p> </o:p></p>
</div>
<div>
<p class="MsoNormal">I'm available for questions so please reach out as needed. I hope this covers our current status.<o:p></o:p></p>
</div>
<div>
<p class="MsoNormal"><o:p> </o:p></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.<o:p></o:p></p>
</div>
<div>
<p class="MsoNormal">Anne<o:p></o:p></p>
</div>
<div>
<p class="MsoNormal"><o:p> </o:p></p>
</div>
<p class="MsoNormal">-- <o:p></o:p></p>
<div>
<div>
<div>
<div>
<div>
<p class="MsoNormal">Anne Gentle<o:p></o:p></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><o:p></o:p></p>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</body>
</html>