Clean up heat-translator documentation
Several RST formatting errors, added some more content too. Change-Id: I44a557398e668152c38ddad07c01ea6cd38b65ea
This commit is contained in:
parent
2f9f244b29
commit
175af0fe58
13
README.rst
13
README.rst
@ -1,13 +1,10 @@
|
|||||||
===============================
|
===============
|
||||||
heat-translator
|
heat-translator
|
||||||
===============================
|
===============
|
||||||
|
|
||||||
Tool to translate non-heat templates to Heat Orchestration Template.
|
Tool to translate non-heat templates to Heat Orchestration Template.
|
||||||
|
|
||||||
* Free software: Apache license
|
* Free software: Apache license
|
||||||
* Documentation: http://docs.openstack.org/developer/heat-translator
|
* Documentation: http://heat-translator.readthedocs.org/
|
||||||
|
* Bugs: https://launchpad.net/heat-translator
|
||||||
Features
|
* Source: https://github.com/stackforge/heat-translator/
|
||||||
--------
|
|
||||||
|
|
||||||
* TODO
|
|
||||||
|
@ -4,14 +4,19 @@
|
|||||||
contain the root `toctree` directive.
|
contain the root `toctree` directive.
|
||||||
|
|
||||||
Welcome to heat-translator's documentation!
|
Welcome to heat-translator's documentation!
|
||||||
========================================================
|
===========================================
|
||||||
|
|
||||||
|
The heat-translator tool is aimed to translate non-heat templates to OpenStack
|
||||||
|
Heat Orchestration Template (HOT). Initially the tool is aimed to translate
|
||||||
|
OASIS Topology and Orchestration Specification for Cloud Applications (TOSCA)
|
||||||
|
to HOT. However, the tool can be easily extended to support any non-heat
|
||||||
|
template format to produce HOT.
|
||||||
|
|
||||||
Contents:
|
Contents:
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
readme
|
|
||||||
installation
|
installation
|
||||||
usage
|
usage
|
||||||
contributing
|
contributing
|
||||||
|
@ -1 +0,0 @@
|
|||||||
.. include:: ../README.rst
|
|
@ -1,6 +1,6 @@
|
|||||||
========
|
=====
|
||||||
Usage
|
Usage
|
||||||
========
|
=====
|
||||||
|
|
||||||
To use heat-translator in a project::
|
To use heat-translator in a project::
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user