Current properties lists in resource's documentation are confusing

Bug #1486549 reported by Peter Razumovsky
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Heat
Fix Released
Undecided
Peter Razumovsky

Bug Description

Current properties lists in resource's documentation are confusing when searching required properties of reosurce. Suggest to separate every properties list in documentation page http://docs.openstack.org/developer/heat/template_guide/openstack.html to two subparagraphs: required and optional.

Changed in heat:
assignee: nobody → Peter Razumovsky (prazumovsky)
Revision history for this message
Pavlo Shchelokovskyy (pshchelo) wrote :

I don't think we should change the output of resource-type-show. It should be machine-readable and be as close to the actual resource schema as possible. Formatting docs for easier visuals and navigation would suffice.

Revision history for this message
Peter Razumovsky (prazumovsky) wrote :

OK, I'll fix description

description: updated
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/215512

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

Reviewed: https://review.openstack.org/215512
Committed: https://git.openstack.org/cgit/openstack/heat/commit/?id=9aee53d3933816ebd8cfc06f651a1a11fb60939d
Submitter: Jenkins
Branch: master

commit 9aee53d3933816ebd8cfc06f651a1a11fb60939d
Author: Peter Razumovsky <email address hidden>
Date: Fri Aug 21 11:27:32 2015 +0300

    Add properties grouping by necessity in docs

    Current resources page description has confusing
    lists of properties, user have to search required
    and optional properties, and this is unconvenient.
    Add grouping by necessity of property: required and
    optional.

    Change-Id: I9b586faa21b275232bb5b323af4d4e1497d1a79b
    Closes-bug: #1486549

Changed in heat:
status: In Progress → Fix Committed
Changed in heat:
milestone: none → liberty-3
status: Fix Committed → Fix Released
Thierry Carrez (ttx)
Changed in heat:
milestone: liberty-3 → 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.