<html><body>
<p><tt><font size="2">> From: Gauvain Pocentek <gauvain.pocentek@objectif-libre.com></font></tt><br>
<tt><font size="2">> To: openstack-docs <openstack-docs@lists.openstack.org></font></tt><br>
<tt><font size="2">> Date: 07/16/2014 02:14 PM</font></tt><br>
<tt><font size="2">> Subject: [Openstack-docs] Heat templates guide</font></tt><br>
<tt><font size="2">> <br>
> Hi all,<br>
> <br>
> We discussed how to add a HOT template guide ([bp]) off list and we'd <br>
> like to have some feedback before getting really started.<br>
> <br>
> So what we plan to do is:<br>
> <br>
> - Write the guide in RST and generate a docbook chapter (the tool to do <br>
> so is almost ready) that will be included in the user guide. We really <br>
> think this is the way to go, because we want to make things easier for <br>
> developers to contribute. So unless there are strong feelings against <br>
> this, we'll probably get started soon.<br>
> <br>
> - We (I?)'d like to include the HOT reference ([ref]) in the manuals, <br>
> but we're not sure where we should include it. Including it in the user <br>
> guide would probably clutter this guide, the CLI and config references <br>
> don't look like good candidates either, and another guide just for this <br>
> is probably overkill. A last solution is to keep the (unversioned) <br>
> reference in the developer/ namespace.<br>
> What do you guys think about this?</font></tt><br>
<br>
<tt><font size="2">I've been starting to think that there ought to be various infrastructure (or an "under the covers") </font></tt><br>
<tt><font size="2">guides, because I've been finding places where, while the existing documentation is essentially correct,</font></tt><br>
<tt><font size="2">they are incomplete in terms of the details of what exactly is happening. </font></tt><br>
<br>
<tt><font size="2">Adding such details would risk cluttering up the existing document (as you've noted) and such</font></tt><br>
<tt><font size="2">a set of guides could both provide deeper insight into how particular components work and provide </font></tt><br>
<tt><font size="2">a natural landing space for documentation such as this. </font></tt><br>
<br>
<tt><font size="2">Ryan Moats (regXboi)</font></tt></body></html>