From 175af0fe58a1beb0b8ac5eb28d266109a6aa44f5 Mon Sep 17 00:00:00 2001 From: Steve Martinelli Date: Thu, 28 Aug 2014 11:41:15 -0400 Subject: [PATCH] Clean up heat-translator documentation Several RST formatting errors, added some more content too. Change-Id: I44a557398e668152c38ddad07c01ea6cd38b65ea --- README.rst | 13 +++++-------- doc/source/index.rst | 9 +++++++-- doc/source/readme.rst | 1 - doc/source/usage.rst | 6 +++--- 4 files changed, 15 insertions(+), 14 deletions(-) delete mode 100644 doc/source/readme.rst diff --git a/README.rst b/README.rst index 6856fe97..9dff7bb9 100644 --- a/README.rst +++ b/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 \ No newline at end of file +* Documentation: http://heat-translator.readthedocs.org/ +* Bugs: https://launchpad.net/heat-translator +* Source: https://github.com/stackforge/heat-translator/ diff --git a/doc/source/index.rst b/doc/source/index.rst index 70135124..dd3f04f2 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -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 diff --git a/doc/source/readme.rst b/doc/source/readme.rst deleted file mode 100644 index 6b2b3ec6..00000000 --- a/doc/source/readme.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../README.rst \ No newline at end of file diff --git a/doc/source/usage.rst b/doc/source/usage.rst index 68dd42c7..4089dec2 100644 --- a/doc/source/usage.rst +++ b/doc/source/usage.rst @@ -1,7 +1,7 @@ -======== +===== Usage -======== +===== To use heat-translator in a project:: - import heat-translator \ No newline at end of file + import heat-translator