openstack/reno
Code Issues Proposed changes

Add deprecations section to usage documentation

Browse Source 
This includes information on the section deprecations and
a consideration when using it.

Change-Id: I581a8afa3491eef74af1472c57d0c35273f45f89
This commit is contained in:
Mike Perez
2016-03-01 11:01:32 -08:00
parent a9362189ca
commit 13b932f0f2
1 changed files with 9 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
doc/source/usage.rst
View File

@@ -64,6 +64,13 @@ upgrade
A list of upgrade notes in the release. For example, if a database
schema alteration is needed.
deprecations
A list of features, APIs, configuration options to be deprecated in the
release. Deprecations should not be used for something that is removed in the
release, use upgrade section instead. Deprecation should allow time for users
to make necessary changes for the removal to happen in a future release.
critical
A list of *fixed* critical bugs.
@@ -96,6 +103,8 @@ entirely.
- List known issues here, or remove this section.
upgrade:
- List upgrade notes here, or remove this section.
deprecations:
- List deprecation notes here, or remove this section
critical:
- Add critical notes here, or remove this section.
security: