openstack/heat
Code Issues Proposed changes

Re-organise top-level template guide structure

Browse Source 
The current structure must be baffling for new template authors.

First is a section on Environments, which is actually an advanced
topic. Then is a section on cfn compatible functions which users
should be spurning in favour of HOT intrinisic functions.

The actual docs on how to write a HOT template and the HOT spec
is buried at the end.

This change remedies this state of affairs by moving the
Heat Orchestration Template (HOT) Guide to the start, followed by
the HOT spec.

The Environments section is now after the resource types, and the
Functions section has been renamed CloudFormation Compatible
Functions.

How we document CloudFormation coverage probably needs to be
rethought, but that is beyond the scope of this change.

Change-Id: I2ef2568309427b37555bae3d6b24a1464a7379b1
This commit is contained in:
Steve Baker 2014-06-26 17:05:26 +12:00
parent e6da405aa2
commit a2eb685d23
2 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/source/template_guide/functions.rst
View File

@ -11,11 +11,12 @@
License for the specific language governing permissions and limitations
under the License.
==================
Built in functions
==================
===================================
CloudFormation Compatible Functions
===================================
There are a number of functions that you can use to help you write templates.
There are a number of functions that you can use to help you write
CloudFormation compatible templates.
All of these functions (except *Ref*) start with *Fn::*.

8
doc/source/template_guide/index.rst
View File

@ -17,10 +17,10 @@ Template Guide
.. toctree::
:maxdepth: 2
environment
functions
hot_guide
hot_spec
openstack
cfn
contrib
hot_guide
hot_spec
environment
functions