openstack
/
heat
Code Issues Proposed changes

Fix the documentation for HIDDEN support status 

There were a few inaccuracies in the documentation for the HIDDEN
support status.

Change-Id: I0960c5e342f01035834ce82520eb64e5ded84c6a
This commit is contained in:
Jason Dunsmore 2016-05-06 15:18:24 -05:00
parent 6c893e2e02
commit 95ad071293
1 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
doc/source/developing_guides/supportstatus.rst
View File

@ -34,13 +34,14 @@ which has follow options:
- DEPRECATED. Object with this status is available, but using it in - DEPRECATED. Object with this status is available, but using it in
code or templates is undesirable. As usual, can be reference in message code or templates is undesirable. As usual, can be reference in message
to new object, which can be used instead of deprecated resource. to new object, which can be used instead of deprecated resource.
- HIDDEN. Object with this status is unavailable and can't be used - HIDDEN. The last step in the deprecation process. Old stacks
anywhere else. Old stacks with such object continue running. containing resources in this status will continue
All new stacks cannot be created with such object. HIDDEN status functioning. Certain functionality is disabled for resources in
notifies, that object is unavailable for using in templates, because can this status (resource-type-list, resource-type-show, and
be deleted later. Object with HIDDEN status is not displaying in resource-type-template). Resources in HIDDEN status are not
resource-type-show and in documentation. See below more details about included in the documentation. A known limitation is that new
removing and deprecating process. stacks can be created with HIDDEN resources. See below for more
details about the removal and deprecation process.
- UNSUPPORTED. Resources with UNSUPPORTED status are not supported by Heat - UNSUPPORTED. Resources with UNSUPPORTED status are not supported by Heat
team, i.e. user can use it, but it may be broken. team, i.e. user can use it, but it may be broken.