openstack/openstack-manuals
Code Issues Proposed changes

Minor edits in the HOT guide

Browse Source 
Reworded hot version configuration and added link to the HOT specification.

backport: none
Closes-Bug: #1431217
Change-Id: I65fc67cb658fe22f4731a8356e05517594802851
This commit is contained in:
darrenchan 2015-05-11 13:11:31 +10:00 committed by Andreas Jaeger
parent b00bd159b2
commit 2fc4125800
1 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
doc/user-guide/source/hot-guide/hot_hello_world.rst
View File

@ -52,12 +52,15 @@ could be used to deploy a single compute instance:
image: ubuntu-trusty-x86_64 image: ubuntu-trusty-x86_64
flavor: m1.small flavor: m1.small
Each HOT template has to include the ``heat_template_version`` key with value Each HOT template must include the ``heat_template_version`` key with
``2013-05-23``, the current HOT version. While the ``description`` key is the HOT version value, for example, ``2013-05-23``. A list of HOT template
optional, it is good practice to include some useful text that describes what versions can be found at `Heat Template Version
users can do with the template. In case you want to provide a longer file <http://docs.openstack.org/developer/heat/template_guide/hot_spec.html#heat-template-version>`__
description that does not fit on a single line, you can provide multi-line text
in YAML, for example: The ``description`` key is optional, however it is good practice to include
some useful text that describes what users can do with the template.
In case you want to provide a longer description that does not fit on
a single line, you can provide multi-line text in YAML, for example:
.. code-block:: yaml .. code-block:: yaml