Difference between revisions of "Documentation/Migrate"
Annegentle (talk | contribs) (Created page with "== API Dev Doc Migration from DocBook to RST == Many of the API reference documents were meant for the contributor developer to know what was going into an API. So, the histo...") |
(No difference)
|
Revision as of 16:35, 20 August 2014
API Dev Doc Migration from DocBook to RST
Many of the API reference documents were meant for the contributor developer to know what was going into an API. So, the history of that document was forged as a specification. As projects beyond swift and nova were added, projects made similar documents. They're output to HTML at http://docs.openstack.org/api/api-specs.html. However, as we now have a <project>-specs repo, it makes sense to move to those repos. In that move, also it makes sense to migrate to RST rather than DocBook/WADL.
The Juno projects where this document needs to migrate to a specification are: nova (compute-api) v2, v3 swift (object-api) v1 glance (image-api) v1, v1.1, v2 keystone (identity-api) v2.0, v3 neutron (netconn-api) v1.0, v2.0 cinder (volume-api) v1.0, v2.0
Juno projects that have this type of document in a separate <service>-api repo are: trove (trove)
Juno projects that do not provide this type of prose-based spec for their API are: ceilometer heat sahara
Incubating projects, this information is just a heads-up so you know how we're thinking about API documentation going forward. ironic zaqar (marconi) barbican designate
I'm going to do the migration work with pandoc and propose the patch to the project's repo. Be on the lookout for those patches.
