openstack-manuals

Give proper titles to config-ref tables

Bug #1361026 reported by Gauvain Pocentek
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
openstack-manuals
Fix Released
Medium
Andreas Jaeger
openstack-manuals juno

Bug Description

autohelp.py generates the titles using the keywords defined in the flagmapping files, which are not really user friendly or even descriptive. This could probably be improved.

2 ideas off the top of my head:
- capitalize and replace _ by a space (zone_fabric -> Zone Fabric)
- provide a keyword:title map

or both (use the map if the transformation is not satisfying).

Tags: doc-tools
Andreas Jaeger (jaegerandi)
Changed in openstack-manuals:
assignee: nobody → Andreas Jaeger (jaegerandi)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Related fix proposed to openstack-manuals (master)

Related fix proposed to branch: master
Review: https://review.openstack.org/116689

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

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

Andreas Jaeger (jaegerandi)
Changed in openstack-manuals:
milestone: none → juno
OpenStack Infra (hudson-openstack)
Changed in openstack-manuals:
assignee: Andreas Jaeger (jaegerandi) → Gauvain Pocentek (gpocentek)
Andreas Jaeger (jaegerandi)
Changed in openstack-manuals:
assignee: Gauvain Pocentek (gpocentek) → Andreas Jaeger (jaegerandi)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to openstack-doc-tools (master)

Reviewed: https://review.openstack.org/116690
Committed: https://git.openstack.org/cgit/openstack/openstack-doc-tools/commit/?id=13019d82747ea44d549e6a8fab41b7708fe252c1
Submitter: Jenkins
Branch: master

commit 13019d82747ea44d549e6a8fab41b7708fe252c1
Author: Andreas Jaeger <email address hidden>
Date: Mon Aug 25 19:46:44 2014 +0200

    autohelp: Set table names

    Use PROJECT.headers file to map categories to table names.

    Change-Id: Iec437160c40f0c51f731e40e043bfbd163c0c83c
    Closes-Bug: #1361026

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

Reviewed: https://review.openstack.org/116706
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=3a78239649fa22640ccf57873297869fc3e6e276
Submitter: Jenkins
Branch: master

commit 3a78239649fa22640ccf57873297869fc3e6e276
Author: Andreas Jaeger <email address hidden>
Date: Mon Aug 25 21:31:38 2014 +0200

    Regenerate cinder tables, add table header

    Regenerate the cinder tables and add first table headers.

    Related-Bug: #1361026
    Change-Id: Iccb27159cae78f19f653e3cdc43ab13bd1f90633

Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

Reviewed: https://review.openstack.org/116689
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=e9416d2667eea6e77c652da518ab3ac3e3166711
Submitter: Jenkins
Branch: master

commit e9416d2667eea6e77c652da518ab3ac3e3166711
Author: Andreas Jaeger <email address hidden>
Date: Mon Aug 25 19:44:42 2014 +0200

    Regenerate trove tables

    Update trove tables.
    Add new file trove.headers for nicer names of the tables.

    Change-Id: If2a800e3442a4b863f02adb161103f971cdb1124
    Related-Bug: #1361026

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.
Subscribing...

Other bug subscribers

Remote bug watches

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