[OpenStack-docs] Improve the HOT reference guide

Christian Berendt christian at berendt.io
Thu Mar 12 14:36:00 UTC 2015


Yesterday I played around with Heat/HOT and used the HOT reference guide
the first time.

At the moment it is rather difficult to read the reference. For example
it is not directly visible if a parameter is optional or not and the
default values are not directly visible.

Also I am missing a generic description for each resource and a pointer
to the used OpenStack component (there are already resources with
descriptions, for example
http://docs.openstack.org/hot-reference/content/OS__Heat__SoftwareDeployment.html).

Some listed properties are wrong (I hit one resource with a propertie
router and it should be router_id instead).

Nits:

missing syntax highlighting for the HOT Syntax

missing highlighting of code, parameters, literals, .. inside
description texts

difference template versions in the examples (for example at
http://docs.openstack.org/hot-reference/content/OS__Nova__Server.html:
2013-05-23 for HOT, 2012-12-12 for YAML and 2010-09-09 for JSON.

resources should be grouped to increase the table of contents

Christian.



More information about the OpenStack-docs mailing list