[openstack-dev] [Magnum] Using common tooling for API docs
hongbin.lu at huawei.com
Fri Aug 12 21:43:58 UTC 2016
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  for generating API docs by using Swagger. However, I am not sure if Swagger belongs to “common tooling” (docs team, please confirm).
From: Anne Gentle [mailto:annegentle at justwriteclick.com]
Sent: August-10-16 3:50 PM
To: OpenStack Development Mailing List; openstack-docs at lists.openstack.org
Subject: [openstack-dev] [api] [doc] API status report
I wanted to report on status and answer any questions you all have about the API reference and guide publishing process.
The expectation is that we provide all OpenStack API information on developer.openstack.org<http://developer.openstack.org>. 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.
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. https://review.openstack.org/#/c/316381/
--Theme, extension, release requirements--
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: http://lists.openstack.org/pipermail/openstack-dev/2016-August/101112.html I hope to meet the requirements deadline to get those changes landed. Requirements freeze is Aug 29.
The current status for project coverage is that these projects are now using the RST+YAML in-tree workflow and tools and publishing to http://developer.openstack.org/api-ref/<servicename> so they will be included in the upcoming API navigation sidebar intended to span all OpenStack APIs:
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.
--Projects not using common tooling--
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.
Please reach out if you have questions or need assistance getting started with the new common tooling, documented here: http://docs.openstack.org/contributor-guide/api-guides.html.
For searchlight, looking at http://developer.openstack.org/api-ref/search/ they have the build job, but the info is not complete yet.
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?
--Redirects from old pages--
We have been adding .htaccess redirects from the old api-ref-servicename.html on developer.openstack.org<http://developer.openstack.org> 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:
I'm available for questions so please reach out as needed. I hope this covers our current status.
A million thank yous to everyone who got us this far! Great teamwork, great docs work, great UI work, and great API work everyone.
-------------- next part --------------
An HTML attachment was scrubbed...
-------------- next part --------------
An embedded and charset-unspecified text was scrubbed...
More information about the OpenStack-dev