we need better linking in documentation

Bug #1486429 reported by Pavlo Shchelokovskyy
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Heat
Fix Released
Medium
Steve Baker

Bug Description

it is quite cumbersome to share links to our template resources guide as there is no possibility to link to a particular property or attribute of a given resource.

we should add permalinks to them (but probably try to hide them from table of contents to keep it slim)

Changed in heat:
status: New → Triaged
importance: Low → Medium
assignee: nobody → Steve Baker (steve-stevebaker)
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/216456

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

Reviewed: https://review.openstack.org/216456
Committed: https://git.openstack.org/cgit/openstack/heat/commit/?id=25f707cdf01f17ea0156fb1970f81396339cc39e
Submitter: Jenkins
Branch: master

commit 25f707cdf01f17ea0156fb1970f81396339cc39e
Author: Steve Baker <email address hidden>
Date: Tue Aug 25 10:08:54 2015 +1200

    Use sections for individual properties and attributes

    It is often helpful to point people at the documentation
    for a specific attribute or property. This change achieves
    this by using sections instead if definition items to
    format the documentation of a property/attribute.

    Complex property schemas are indented using block quotes
    and the fragment identifier is appended to so that each
    link is unique. (eg, #OS::Ceilometer::Alarm-prop-query-*-field)

    The 'required' and 'optional' sections have been brought up one
    level, replacing 'Properties' with 'Required Properties' and
    'Optional Properties'.

    Closes-Bug: #1486429
    Change-Id: Ifd497aac74e8aff76ea91a295df17bb1da949ba8

Changed in heat:
status: In Progress → Fix Committed
Changed in heat:
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.