Open Stack

Hi Christian,

Most of the improvements you suggest should be done in the heat 
docstrings. The reference is generated from the heat source code, using 
tools developed by the heat team (see the sphinx extension in the 
doc/source/ dir). If you or anyone want to tackle this, I'd be happy to 
provide pointers and documentation.

I'm aware that this reference could be much better but unfortunately I 
don't have enough time to work on improving it.

Thanks,
Gauvain

Le 2015-03-12 15:36, Christian Berendt a écrit :
> 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.
> 
> _______________________________________________
> OpenStack-docs mailing list
> OpenStack-docs at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs

Gauvain Pocentek

Objectif Libre - Infrastructure et Formations Linux
http://www.objectif-libre.com