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
This commit is contained in:
Zane Bitter 2018-04-02 15:55:43 -04:00
parent 2c63287420
commit dea4bd18e0
5 changed files with 37 additions and 44 deletions

View File

@ -114,7 +114,7 @@ master_doc = 'index'
# General information about the project. # General information about the project.
project = u'Heat' 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 # The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages. # for a list of supported languages.
@ -149,7 +149,7 @@ exclude_patterns = ['**/#*', '**~', '**/#*#']
pygments_style = 'sphinx' pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting. # A list of ignored prefixes for module index sorting.
# modindex_common_prefix = [] modindex_common_prefix = ['heat.']
primary_domain = 'py' primary_domain = 'py'
nitpicky = False nitpicky = False

View File

@ -44,29 +44,19 @@ This documentation offers information aimed at end-users, operators and
developers of Heat. developers of Heat.
Installing Heat Operating Heat
=============== ==============
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
install/index install/index
operating_guides/httpd
Configuring Heat
================
.. toctree::
:maxdepth: 1
configuration/index configuration/index
Administering Heat
==================
.. toctree::
:maxdepth: 1
admin/index admin/index
operating_guides/scale_deployment
operating_guides/upgrades_guide
man/index
Using Heat Using Heat
========== ==========
@ -75,25 +65,29 @@ Using Heat
:maxdepth: 1 :maxdepth: 1
getting_started/create_a_stack getting_started/create_a_stack
template_guide/index
templates/index
glossary glossary
Operating Heat Working with Templates
============== ----------------------
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
getting_started/on_fedora template_guide/index
getting_started/on_ubuntu templates/index
operating_guides/scale_deployment
operating_guides/httpd Using the Heat Service
operating_guides/upgrades_guide ----------------------
man/index
- `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 Developing Heat
=============== ===============
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
@ -105,20 +99,7 @@ Developing Heat
developing_guides/gmr developing_guides/gmr
developing_guides/supportstatus developing_guides/supportstatus
developing_guides/rally_on_gates developing_guides/rally_on_gates
api/index
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
Indices and tables Indices and tables
================== ==================

View File

@ -11,12 +11,15 @@
License for the specific language governing permissions and limitations License for the specific language governing permissions and limitations
under the License. under the License.
======================================
AWS Wordpress Single Instance Template AWS Wordpress Single Instance Template
-------------------------------------- ======================================
https://git.openstack.org/cgit/openstack/heat-templates/tree/cfn/F18/WordPress_Single_Instance.template https://git.openstack.org/cgit/openstack/heat-templates/tree/cfn/F18/WordPress_Single_Instance.template
Description Description
----------- -----------
AWS CloudFormation Sample Template WordPress_Single_Instance: WordPress is web AWS CloudFormation Sample Template WordPress_Single_Instance: WordPress is web
software you can use to create a beautiful website or blog. This template 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 installs a single-instance WordPress deployment using a local MySQL database to
@ -25,6 +28,7 @@ store the data.
Parameters Parameters
---------- ----------
*KeyName* :mod:`(required)` *KeyName* :mod:`(required)`
*type* *type*
*string* *string*

View File

@ -11,18 +11,22 @@
License for the specific language governing permissions and limitations License for the specific language governing permissions and limitations
under the License. under the License.
========================
Hello World HOT Template Hello World HOT Template
------------------------ ========================
https://git.openstack.org/cgit/openstack/heat-templates/tree/hot/hello_world.yaml https://git.openstack.org/cgit/openstack/heat-templates/tree/hot/hello_world.yaml
Description Description
----------- -----------
Hello world HOT template that just defines a single compute instance. Contains Hello world HOT template that just defines a single compute instance. Contains
just base features to verify base HOT support. just base features to verify base HOT support.
Parameters Parameters
---------- ----------
*key_name* :mod:`(required)` *key_name* :mod:`(required)`
*type* *type*
*string* *string*

View File

@ -11,6 +11,10 @@
License for the specific language governing permissions and limitations License for the specific language governing permissions and limitations
under the License. under the License.
=================
Example Templates
=================
This page documents the templates at https://git.openstack.org/cgit/openstack/heat-templates/ This page documents the templates at https://git.openstack.org/cgit/openstack/heat-templates/
Example HOT Templates Example HOT Templates