添加关于 heat 模板的文档¶

在用户指南中添加一章¶

第一部分将涵盖模板的基本方面

• 架构、格式和语言
• 资源定义
• 参数定义
• 函数和属性的使用
• 资源之间的链接

本节将涵盖基本资源：nova 服务器、neutron 网络、子网和端口、cinder 卷

第二部分将记录如何使用更复杂的资源，例如

• WaitConditions
• HA 和告警
• AutoScaling

提供新的指南：HOT 参考¶

此指南将从 heat 源代码和文档中自动构建。

备选方案¶

我们之前在邮件列表中讨论过的一些替代方案包括

• 在 openstack-manuals 中为模板启动一个新的独立指南，以 DocBook 格式进行源文件管理。我们决定为新的非自动化指南付出的开销太大，而且最终用户会想知道它的存在。
• 将整个用户指南从 DocBook 转换为 RST 并使用 oslosphinx 模板进行构建。我们将失去翻译工具链，并且从这个输出链生成的 PDF 效果不如 DocBook PDF。

因此，为了兼顾两种工具链的优点，该提案选择在用户指南中创建一个章节，最终以 DocBook 格式呈现，但通过 RST 路径实现。

负责人¶

Gauvain Pocentek (gpocentek)

工作项¶

• 编写 RST 到 DocBook 的转换工具。
• 以 RST 格式编写文档。
• 在准备好后将转换结果导入用户指南。
• （也许）自动化未来的更新导入。
• 自动发布 heat 模板的参考信息到单独的指南中。