Add documantation for rules to write API reference

Registered by Takashi NATSUME on 2018-05-10

Add documents for writing API reference in the Contributor Documentation of the Nova developers reference.

https://docs.openstack.org/nova/latest/contributor/index.html#the-nova-api

There are some discussion about description of API reference in the openstack-dev mailing-list.
And there is a wiki for rules to write (verify) API reference.
The documents will be created by merging them.

http://lists.openstack.org/pipermail/openstack-dev/2016-April/092234.html
https://wiki.openstack.org/wiki/NovaAPIRef
http://lists.openstack.org/pipermail/openstack-dev/2017-January/109868.html
http://lists.openstack.org/pipermail/openstack-dev/2017-July/119239.html

This is a specless blueprint.

Blueprint information

Status:
Complete
Approver:
melanie witt
Priority:
Undefined
Drafter:
Takashi NATSUME
Direction:
Needs approval
Assignee:
Takashi NATSUME
Definition:
Obsolete
Series goal:
None
Implementation:
Unknown
Milestone target:
None
Completed by
melanie witt on 2018-05-10

Related branches

Sprints

Whiteboard

You don't need a blueprint for adding documentation to the code base -- you can go ahead and propose patches for the new documentation without this blueprint. You can add a link from the contributor docs to the api-ref wiki. I'm going to close this blueprint as Obsolete because it's not needed. -- melwitt 2018-05-10

(?)

Work Items

This blueprint contains Public information 
Everyone can see this information.

Subscribers

No subscribers.