Updates to the template about policy changes

Updated the API section to add a note about policy changes.

This highlights an inconsistency in the section titles that I have
also addressed as part of this change. There are deployer impacts
mentioned in many sections outside the deployer impact section.

Ideas are taken from early revisions of:
https://review.openstack.org/#/c/82166

Change-Id: Ie2161adcfe378ce33e5406f35a2cf1a14fbcc25b
This commit is contained in:
John Garbutt 2014-03-25 12:41:56 +00:00 committed by Gerrit Code Review
parent d47de6de34
commit a92e8ffe73
1 changed files with 7 additions and 4 deletions

View File

@ -101,6 +101,9 @@ Each API method which is either added or changed should have the following
* Example use case including typical API samples for both data supplied
by the caller and the response
* Discuss any policy changes, and discuss what things a deployer needs to
think about when defining their policy.
Example JSON schema definitions can be found in the Nova tree
http://git.openstack.org/cgit/openstack/nova/tree/nova/api/openstack/compute/schemas/v3
@ -177,11 +180,11 @@ Examples of things to consider here include:
- Will the change include any locking, and if so what considerations are there on
holding the lock?
Deployer impact
---------------
Other Deployer impact
---------------------
Discuss things that will affect how you deploy and configure OpenStack,
such as:
Discuss things that will affect how you deploy and configure OpenStack
that have not already been mentioned, such as:
- What config options are being added? Should they be more generic than
proposed (for example a flag that other hypervisor drivers might want to