Merge "Clean up heat-translator documentation"
This commit is contained in:
commit
be799ae629
13
README.rst
13
README.rst
@ -1,13 +1,10 @@
|
||||
===============================
|
||||
===============
|
||||
heat-translator
|
||||
===============================
|
||||
===============
|
||||
|
||||
Tool to translate non-heat templates to Heat Orchestration Template.
|
||||
|
||||
* Free software: Apache license
|
||||
* Documentation: http://docs.openstack.org/developer/heat-translator
|
||||
|
||||
Features
|
||||
--------
|
||||
|
||||
* TODO
|
||||
* Documentation: http://heat-translator.readthedocs.org/
|
||||
* Bugs: https://launchpad.net/heat-translator
|
||||
* Source: https://github.com/stackforge/heat-translator/
|
||||
|
@ -4,14 +4,19 @@
|
||||
contain the root `toctree` directive.
|
||||
|
||||
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:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
readme
|
||||
installation
|
||||
usage
|
||||
contributing
|
||||
|
@ -1 +0,0 @@
|
||||
.. include:: ../README.rst
|
@ -1,7 +1,7 @@
|
||||
========
|
||||
=====
|
||||
Usage
|
||||
========
|
||||
=====
|
||||
|
||||
To use heat-translator in a project::
|
||||
|
||||
import heat-translator
|
||||
import heat-translator
|
||||
|
Loading…
Reference in New Issue
Block a user