Docs nested schema inaccurate replacement text

Bug #1399120 reported by Steven Hardy
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Heat
Fix Released
Low
Tatiana Kholkina

Bug Description

In our docs:

http://docs.openstack.org/developer/heat/template_guide/openstack.html#OS::Heat::ResourceGroup

Nested schema items all say "Updates cause replacement.", but AFAIK this is not true, if the top-level schema specifies update_allowed=True.

So we probably need a way for either the docs generation to get smarter and only look at the top-level schema, or add update_allowed=True to all the nested schema items where allowed by the top level property. The former approach seems better and less error-prone :)

Angus Salkeld (asalkeld)
Changed in heat:
status: New → Triaged
importance: Undecided → Low
Changed in heat:
assignee: nobody → Tetiana Lashchova (tlashchova)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to heat (master)

Fix proposed to branch: master
Review: https://review.openstack.org/167222

Changed in heat:
status: Triaged → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to heat (master)

Reviewed: https://review.openstack.org/167222
Committed: https://git.openstack.org/cgit/openstack/heat/commit/?id=012107dedc4c5d6a06f02bd0f1d7c49485c7a10f
Submitter: Jenkins
Branch: master

commit 012107dedc4c5d6a06f02bd0f1d7c49485c7a10f
Author: Tetiana Lashchova <email address hidden>
Date: Tue Mar 24 15:15:47 2015 +0200

    Get 'update' paragraph from top-level schema

    Change-Id: I4e3ed92303fa268afd5583cc76e3536b18478294
    Closes-Bug: #1399120

Changed in heat:
status: In Progress → Fix Committed
Thierry Carrez (ttx)
Changed in heat:
milestone: none → liberty-2
status: Fix Committed → Fix Released
Thierry Carrez (ttx)
Changed in heat:
milestone: liberty-2 → 5.0.0
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.