Difference between revisions of "Neutron/BlueprintTemplate"
| Line 4: | Line 4: | ||
== Template == | == Template == | ||
| − | ''' | + | '''Scope:'''''' '''[Short overview and high level description of what the blueprint is trying to achieve.] |
| − | ''' | + | '''Use Cases'''''':'''''' '''[Short overview and high level description of what the blueprint is trying to achieve.] |
| + | |||
| + | '''Implementation Overview: '''[Provide an overview of the implementation and any algorithms that will be used] | ||
| + | |||
| + | '''Data Model Changes: '''[Are you introducing new model classes, or extending existing ones?] | ||
'''Configuration variables:''' [List and explanation of the new configuration variables (if they exist)] | '''Configuration variables:''' [List and explanation of the new configuration variables (if they exist)] | ||
| − | ''' | + | '''API's: '''[List and explanation of the new API's (if they exist)] |
| − | |||
| − | |||
'''Plugin Interface: '''[Does this feature introduce any change?] | '''Plugin Interface: '''[Does this feature introduce any change?] | ||
'''Required Plugin support: '''[What should the plugins do to support this new feature? (If applicable)] | '''Required Plugin support: '''[What should the plugins do to support this new feature? (If applicable)] | ||
| + | |||
| + | '''Dependencies: '''[List of python packages and/or OpenStack components? (If applicable)] | ||
| + | |||
| + | '''CLI Requirements: '''[List of CLI requirements (If applicable)] | ||
| + | |||
| + | '''Horizon Requirements: '''[List of Horizon requirements (If applicable)] | ||
| + | |||
| + | '''Usage Example: '''[How to run/use/interface with the new feature. (If applicable)] | ||
| + | |||
| + | '''Test Cases: '''[Description of various test cases. (If applicable)] | ||
<span style="font-size: large; color: green; background: yellow">OK</span> | <span style="font-size: large; color: green; background: yellow">OK</span> | ||
Revision as of 10:07, 24 October 2012
Blueprint Template
Below is an outline for a Blueprint Summary template. The purpose is to try and improve our development, review and release process. Please make sure that you include the sections below. If the section is not relevant the a simple N/A will suffice. In addition to this any links to diagrams will be greatly appreciated - this will be very helpful when we are documenting the feature release.
Template
'Scope:' [Short overview and high level description of what the blueprint is trying to achieve.]
Use Cases':' [Short overview and high level description of what the blueprint is trying to achieve.]
Implementation Overview: [Provide an overview of the implementation and any algorithms that will be used]
Data Model Changes: [Are you introducing new model classes, or extending existing ones?]
Configuration variables: [List and explanation of the new configuration variables (if they exist)]
API's: [List and explanation of the new API's (if they exist)]
Plugin Interface: [Does this feature introduce any change?]
Required Plugin support: [What should the plugins do to support this new feature? (If applicable)]
Dependencies: [List of python packages and/or OpenStack components? (If applicable)]
CLI Requirements: [List of CLI requirements (If applicable)]
Horizon Requirements: [List of Horizon requirements (If applicable)]
Usage Example: [How to run/use/interface with the new feature. (If applicable)]
Test Cases: [Description of various test cases. (If applicable)]
OK
