Move Manila API-Reference in-tree

Registered by Goutham Pacha Ravi on 2016-05-23

Manila's API reference [0] was being maintained in DocBooks [1] and WADL [2] formats. In Mitaka, the OpenStack API documentation team decided to adopt new standards for writing and maintaining API reference. As part of this effort, all projects will be required to move their API reference in-tree. [3]

Manila will follow Nova's style of documenting it's V1 (Supported) and V2 (Current) APIs. [4]

[0] http://developer.openstack.org/api-ref-share-v2.html (Source: https://github.com/openstack/api-site/tree/8da6b92/api-ref/src)
[1] https://github.com/openstack/api-site/blob/8da6b92/api-ref/src/docbkx/api-ref-share-v2.xml
[2] https://github.com/openstack/api-site/tree/8da6b92/api-ref/src/wadls/share-api/src/v2
[3] http://docs.openstack.org/contributor-guide/api-guides.html#how-to-document-api
[4] https://github.com/openstack/nova/tree/25ac5a27/api-ref/source

Blueprint information

Status:
Started
Approver:
Ben Swartzlander
Priority:
Undefined
Drafter:
Goutham Pacha Ravi
Direction:
Needs approval
Assignee:
Goutham Pacha Ravi
Definition:
New
Series goal:
None
Implementation:
Good progress
Milestone target:
None
Started by
Goutham Pacha Ravi on 2016-05-24

Related branches

Sprints

Whiteboard

(?)

Work Items

This blueprint contains Public information 
Everyone can see this information.

Subscribers

No subscribers.