<div dir="ltr">Hi all, <div><br></div><div>Teams are making great progress in the source migration and the even newer styling [1] is looking great! </div><div><br></div><div>What I'd like to ask for help on next is unifying navigation for the content being published to <a href="http://developer.openstack.org/api-ref/">developer.openstack.org/api-ref/</a><service> and <a href="http://developer.openstack.org/api-guide/">developer.openstack.org/api-guide/</a><service>. </div><div><br></div><div>Previously, we had a sidebar for each service and version's API reference document [2]. The sidebar is responsive, however, with the new Sphinx sidebar, the service methods take over the sidebar. Also the prior sidebar navigation was for reference information only. </div><div><br></div><div><div>The request is to provide a navigation that lets readers see all the documented OpenStack APIs in a unified way. Perhaps an upper navigation that can expand would be best. We do have the openstackdocstheme [3] expanding sidebar menu with version info that perhaps can be reused.</div></div><div><br></div><div>Requirements based on our current tooling:</div><div>- Design should integrate well with our current theme, openstackdocstheme. [3]</div><div>- Design should integrate well with the os-api-ref extensions. [4]</div><div>- Design should consider that some APIs have multiple versions.</div><div>- Both of the above are Sphinx-based and include jquery, bootstrap, and CSS integration. Currently has Bootstrap v3.2.0 and JQuery 1.11.3 but these are not required versions.</div><div>- Responsive design required; however mobile is 5% of traffic currently.</div><div>- Primary browsers are Chrome (60%), Firefox (26%), Safari and IE/Edge (about 6% each).</div><div>- Should be able to add links to new API information through patchsets on <a href="http://review.openstack.org">review.openstack.org</a>.</div><div>- Should link to both API reference information and API tutorials and guides.</div><div><br></div><div>If you're interested or have ideas, please write back to the openstack-dev list.</div><div><br></div><div>Thanks,</div><div>Anne</div><div><br></div><div>1. <a href="https://api.os.gra.ham.ie/compute/">https://api.os.gra.ham.ie/compute/</a> Thanks Graham Hayes!</div><div>2. <a href="http://developer.openstack.org/api-ref.html">http://developer.openstack.org/api-ref.html</a></div><div>3. <a href="https://github.com/openstack/openstackdocstheme">https://github.com/openstack/openstackdocstheme</a></div><div>4. <a href="https://github.com/openstack/os-api-ref">https://github.com/openstack/os-api-ref</a></div><div><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>