From 95ad071293cd480bc83af988ee52a7c329704ff6 Mon Sep 17 00:00:00 2001 From: Jason Dunsmore Date: Fri, 6 May 2016 15:18:24 -0500 Subject: [PATCH] Fix the documentation for HIDDEN support status There were a few inaccuracies in the documentation for the HIDDEN support status. Change-Id: I0960c5e342f01035834ce82520eb64e5ded84c6a --- doc/source/developing_guides/supportstatus.rst | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/doc/source/developing_guides/supportstatus.rst b/doc/source/developing_guides/supportstatus.rst index 7822f834cb..b08fadf1a4 100644 --- a/doc/source/developing_guides/supportstatus.rst +++ b/doc/source/developing_guides/supportstatus.rst @@ -34,13 +34,14 @@ which has follow options: - DEPRECATED. Object with this status is available, but using it in code or templates is undesirable. As usual, can be reference in message to new object, which can be used instead of deprecated resource. - - HIDDEN. Object with this status is unavailable and can't be used - anywhere else. Old stacks with such object continue running. - All new stacks cannot be created with such object. HIDDEN status - notifies, that object is unavailable for using in templates, because can - be deleted later. Object with HIDDEN status is not displaying in - resource-type-show and in documentation. See below more details about - removing and deprecating process. + - HIDDEN. The last step in the deprecation process. Old stacks + containing resources in this status will continue + functioning. Certain functionality is disabled for resources in + this status (resource-type-list, resource-type-show, and + resource-type-template). Resources in HIDDEN status are not + included in the documentation. A known limitation is that new + 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 team, i.e. user can use it, but it may be broken.