heat template documentation in wrong place

[Mike Spreitzer]

Cloud users need to know how to read and write Heat templates. But documentation about this is not found in the End User's Guide. It is found in the Python Developer documentation. Heat templates are not *exclusively* the concern of Python developers. That is the wrong place for this information to be.

[Andreas Jaeger (jaegerandi)]

could you give a link to the current documentation, please?

[Mike Spreitzer (mike-spreitzer)]

To find the current template documentation, there are several links from http://docs.openstack.org/developer/heat/

Two lead to http://docs.openstack.org/developer/heat/templates/index.html - which is about two examples (with broken links to the actual templates).

There is also a link to http://docs.openstack.org/developer/heat/template_guide/index.html where you will find the general template documentation.

[Steve Baker (steve-stevebaker)]

I think the heat template guide will always use sphinx since it autogenerates the resource reference section by introspecting the heat codebase.

Having it as a subdirectory of the developer guide was always meant to be a temporary solution, I see a couple of options:

1. allow the heat repo to generate 2 separate sphinx documentation sets, one developer docs and one template guide
2. move the template guide to openstack-manuals (or some other manual repo)

Doing 2 will mean that repo would need to depend on heat, and ideally we could still have a docs job to see what documentation is generated for any heat gerrit review

[Andreas Jaeger (jaegerandi)]

Another idea would be to add links to the template guide from the openstack-manuals that talk about heat.

[Mike Spreitzer (mike-spreitzer)]

I will update the end-user guide to point to the template documentation.

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

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

commit 50300bdd407e31accb86347f9e87d23bd36c58da
Author: Mike Spreitzer <email address hidden>
Date: Wed Mar 19 00:38:28 2014 -0400

    Added pointers to template documentation.

    Also added "Heat Orchestration Template" and "Stack"
    to the glossary.

    Also made a few other changes suggested by reviewers.

    Change-Id: I9856f9664cc104eda7a37d9a0a43ee1a0e534aca
    Closes-Bug: 1281691

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/openstack-manuals 15.0.0 release.