Convert API Reference to RST and host it in the Cinder tree

Registered by Sheel Rana on 2016-05-03

The current API Reference website is based on a baroque publish toolchain using WADL and Maven, which is largely unmaintained. This makes it hard to have an up to date version of our API docs, or describe things like microversions in our docs.

There is a push to convert this to RST instead. We'll be doing that in the cinder now.
This has been implemented in nova tree first to demonstrate this working.

Blueprint information

Status:
Complete
Approver:
Sean McGinnis
Priority:
Medium
Drafter:
Sheel Rana
Direction:
Approved
Assignee:
Sheel Rana
Definition:
Approved
Series goal:
None
Implementation:
Implemented
Milestone target:
None
Started by
Sheel Rana on 2016-05-03
Completed by
Sheel Rana on 2016-10-18

Whiteboard

Addressed by: https://review.openstack.org/312113
    WADL to RST migration

Gerrit topic: https://review.openstack.org/#q,topic:bp/api-reference-to-rst,n,z

Backport to Mitaka release to support XML API:
       Addressed by: https://review.openstack.org/316353
       WADL to RST migration in cinder tree

Gerrit topic: https://review.openstack.org/#q,topic:api-ref_patchset1,n,z

Addressed by: https://review.openstack.org/316587
    Updated volume, version, limit, metadata API-ref

Addressed by: https://review.openstack.org/322489
    Update api-ref path

Addressed by: https://review.openstack.org/361616
    Cleanup api-ref

(?)

Work Items

This blueprint contains Public information 
Everyone can see this information.

Subscribers

No subscribers.