From dea4bd18e06a5d93aeedcf80c8f7be32b1ee9574 Mon Sep 17 00:00:00 2001 From: Zane Bitter Date: Mon, 2 Apr 2018 15:55:43 -0400 Subject: [PATCH] Docs: Reorganise landing page Consolidate into three sections based on the audience: operator, user, and developer. Don't include API autodoc inline, just link to it. Change-Id: I3c301d66dd05698fca3582761cb0177d66431483 --- doc/source/conf.py | 4 +- doc/source/index.rst | 61 +++++++------------ .../cfn/WordPress_Single_Instance.rst | 6 +- doc/source/templates/hot/hello_world.rst | 6 +- doc/source/templates/index.rst | 4 ++ 5 files changed, 37 insertions(+), 44 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index bfdcfc3db4..80de1aaab9 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -114,7 +114,7 @@ master_doc = 'index' # General information about the project. project = u'Heat' -copyright = u'2012,2013 Heat Developers' +copyright = u'(c) 2012- Heat Developers' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -149,7 +149,7 @@ exclude_patterns = ['**/#*', '**~', '**/#*#'] pygments_style = 'sphinx' # A list of ignored prefixes for module index sorting. -# modindex_common_prefix = [] +modindex_common_prefix = ['heat.'] primary_domain = 'py' nitpicky = False diff --git a/doc/source/index.rst b/doc/source/index.rst index 1874570cec..4ff8e79ab0 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -44,29 +44,19 @@ This documentation offers information aimed at end-users, operators and developers of Heat. -Installing Heat -=============== +Operating Heat +============== .. toctree:: :maxdepth: 1 install/index - -Configuring Heat -================ - -.. toctree:: - :maxdepth: 1 - + operating_guides/httpd configuration/index - -Administering Heat -================== - -.. toctree:: - :maxdepth: 1 - admin/index + operating_guides/scale_deployment + operating_guides/upgrades_guide + man/index Using Heat ========== @@ -75,25 +65,29 @@ Using Heat :maxdepth: 1 getting_started/create_a_stack - template_guide/index - templates/index glossary -Operating Heat -============== +Working with Templates +---------------------- .. toctree:: :maxdepth: 1 - getting_started/on_fedora - getting_started/on_ubuntu - operating_guides/scale_deployment - operating_guides/httpd - operating_guides/upgrades_guide - man/index + template_guide/index + templates/index + +Using the Heat Service +---------------------- + +- `OpenStack Orchestration API v1 Reference`_ +- `Python and CLI client`_ + +.. _`OpenStack Orchestration API v1 Reference`: https://developer.openstack.org/api-ref/orchestration/v1/ +.. _`Python and CLI client`: https://docs.openstack.org/python-heatclient/latest Developing Heat =============== + .. toctree:: :maxdepth: 1 @@ -105,20 +99,7 @@ Developing Heat developing_guides/gmr developing_guides/supportstatus developing_guides/rally_on_gates - -API Documentation -======================== - -- `Heat REST API Reference (OpenStack API Complete Reference - Orchestration)`_ - - .. _`Heat REST API Reference (OpenStack API Complete Reference - Orchestration)`: http://developer.openstack.org/api-ref/orchestration/v1/ - -Code Documentation -================== -.. toctree:: - :maxdepth: 1 - - api/autoindex + api/index Indices and tables ================== diff --git a/doc/source/templates/cfn/WordPress_Single_Instance.rst b/doc/source/templates/cfn/WordPress_Single_Instance.rst index 02ca43b875..e7722eb903 100644 --- a/doc/source/templates/cfn/WordPress_Single_Instance.rst +++ b/doc/source/templates/cfn/WordPress_Single_Instance.rst @@ -11,12 +11,15 @@ License for the specific language governing permissions and limitations under the License. +====================================== AWS Wordpress Single Instance Template --------------------------------------- +====================================== + https://git.openstack.org/cgit/openstack/heat-templates/tree/cfn/F18/WordPress_Single_Instance.template Description ----------- + AWS CloudFormation Sample Template WordPress_Single_Instance: WordPress is web software you can use to create a beautiful website or blog. This template installs a single-instance WordPress deployment using a local MySQL database to @@ -25,6 +28,7 @@ store the data. Parameters ---------- + *KeyName* :mod:`(required)` *type* *string* diff --git a/doc/source/templates/hot/hello_world.rst b/doc/source/templates/hot/hello_world.rst index 565cb5ec5a..2658679820 100644 --- a/doc/source/templates/hot/hello_world.rst +++ b/doc/source/templates/hot/hello_world.rst @@ -11,18 +11,22 @@ License for the specific language governing permissions and limitations under the License. +======================== Hello World HOT Template ------------------------- +======================== + https://git.openstack.org/cgit/openstack/heat-templates/tree/hot/hello_world.yaml Description ----------- + Hello world HOT template that just defines a single compute instance. Contains just base features to verify base HOT support. Parameters ---------- + *key_name* :mod:`(required)` *type* *string* diff --git a/doc/source/templates/index.rst b/doc/source/templates/index.rst index bba67fd85f..e561708595 100644 --- a/doc/source/templates/index.rst +++ b/doc/source/templates/index.rst @@ -11,6 +11,10 @@ License for the specific language governing permissions and limitations under the License. +================= +Example Templates +================= + This page documents the templates at https://git.openstack.org/cgit/openstack/heat-templates/ Example HOT Templates