<div dir="ltr"><br><div class="gmail_extra"><br><div class="gmail_quote">On Wed, Aug 10, 2016 at 2:49 PM, Anne Gentle <span dir="ltr"><<a href="mailto:annegentle@justwriteclick.com" target="_blank">annegentle@justwriteclick.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-style:solid;border-left-color:rgb(204,204,204);padding-left:1ex"><div dir="ltr">Hi all, <div>I wanted to report on status and answer any questions you all have about the API reference and guide publishing process.</div><div><br></div><div>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. </div><div><br></div><div>--Migration--</div><div>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></div><div><br></div><div>--Theme, extension, release requirements--</div><div>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.</div><div><br></div><div>--Project coverage--</div><div>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:</div><div><br></div>designate <a href="http://developer.openstack.org/api-ref/dns/" target="_blank">http://developer.<wbr>openstack.org/api-ref/dns/</a><br><div>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></div><div><div><br></div><div>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.</div><div><br></div><div>ceilometer</div></div></div></blockquote><div><br></div><div>Sorry, in reviewing further today I found another project that does not have a publish job but has in-tree source files:</div><div><br></div><div>cinder</div><div><br></div><div>Team cinder: can you let me know where you are in your publishing comfort level? Please add an api-ref-jobs: line with a target of block-storage to jenkins/jobs/projects.yaml in the project-config repo to ensure publishing is correct.</div><div><br></div><div>Another issue is the name of the target directory for the final URL. Team ironic can I change your api-ref-jobs: line to bare-metal instead of baremetal? It'll be better for search engines and for alignment with the other projects URLs: <a href="https://review.openstack.org/354135">https://review.openstack.org/354135</a></div><div><br></div><div>I've also uncovered a problem where a neutron project's API does not have an official service name, and am working on a solution but need help from the neutron team: <a href="https://review.openstack.org/#/c/351407">https://review.openstack.org/#/c/351407</a></div><div>Thanks,</div><div>Anne</div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-style:solid;border-left-color:rgb(204,204,204);padding-left:1ex"><div dir="ltr"><div><div><br></div><div>--Projects not using common tooling--</div><div>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.<br></div><div><br></div><div><div>astara</div><div>cloudkitty</div><div>congress</div><div>magnum</div><div>mistral</div><div>monasca</div><div>solum</div><div>tacker</div><div>trove</div><div><br></div><div>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>.<br></div><div><br></div><div>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. <br></div><div><br></div><div>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?</div><div><div><br>--Redirects from old pages--</div><div>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:</div><div><br></div><div>designate</div><div>glance</div><div>heat</div><div>sahara</div><div>senlin</div><div>swift</div></div><div><br></div><div>I'm available for questions so please reach out as needed. I hope this covers our current status.</div><div><br></div><div>A million thank yous to everyone who got us this far! Great teamwork, great docs work, great UI work, and great API work everyone.</div><span class=""><font color="#888888"><div>Anne<br></div><div><br></div>-- <br><div 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>
</font></span></div></div></div>
</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></div>