From b78e78d8bba0a30fd36de154dcf74c8ed96274a9 Mon Sep 17 00:00:00 2001 From: Zane Bitter Date: Mon, 12 Mar 2018 13:48:02 -0400 Subject: [PATCH] Docs: use local references for internal links Some internal links in the documentation are broken after the re-organisation because they used absolute URLs. Use :ref:, or at least :doc: instead and let Sphinx take care of keeping the links up to date. Also add a redirect for docs we know to have moved, since they may be linked from other places externally. Change-Id: I107f40e23a757052da7f5179338f88369a4a72cb Partial-Bug: #1710084 --- doc/source/_extra/.htaccess | 3 +++ doc/source/install/index.rst | 5 ++--- doc/source/install/launch-instance.rst | 5 +---- doc/source/install/next-steps.rst | 4 ++-- doc/source/operating_guides/scale_deployment.rst | 14 ++++++-------- doc/source/template_guide/hello_world.rst | 8 ++++---- 6 files changed, 18 insertions(+), 21 deletions(-) diff --git a/doc/source/_extra/.htaccess b/doc/source/_extra/.htaccess index 2459e717f7..172e6a9a97 100644 --- a/doc/source/_extra/.htaccess +++ b/doc/source/_extra/.htaccess @@ -1,3 +1,6 @@ # The top-level docs project will redirect URLs from the old /developer docs # to their equivalent pages on the new docs.openstack.org only if this file # exists. + +redirectmatch 301 ^/heat/([^/]+)/(architecture|pluginguide|schedulerhints|gmr|supportstatus)\.html$ /heat/$1/developing_guides/$2.html +redirectmatch 301 ^/heat/([^/]+)/(scale_deployment)\.html$ /heat/$1/operating_guides/$2.html diff --git a/doc/source/install/index.rst b/doc/source/install/index.rst index 6e8a6837cf..3d606b1330 100644 --- a/doc/source/install/index.rst +++ b/doc/source/install/index.rst @@ -11,9 +11,8 @@ Installing Heat launch-instance.rst next-steps.rst -The Orchestration service (heat) uses a -`Heat Orchestration Template (HOT) `_ -to create and manage cloud resources. +The Orchestration service (heat) uses a :ref:`Heat Orchestration Template (HOT) +` to create and manage cloud resources. This chapter assumes a working setup of OpenStack following the `OpenStack Installation Tutorial `_. diff --git a/doc/source/install/launch-instance.rst b/doc/source/install/launch-instance.rst index ed5db8d9ed..f0d73eb417 100644 --- a/doc/source/install/launch-instance.rst +++ b/doc/source/install/launch-instance.rst @@ -10,10 +10,7 @@ Create a template ----------------- The Orchestration service uses templates to describe stacks. -To learn about the template language, see `the Template Guide -`__ -in the `Heat developer documentation -`__. +To learn about the template language, see the :ref:`template-guide`. * Create the ``demo-template.yml`` file with the following content: diff --git a/doc/source/install/next-steps.rst b/doc/source/install/next-steps.rst index 83cae16aa2..2e9cca6b62 100644 --- a/doc/source/install/next-steps.rst +++ b/doc/source/install/next-steps.rst @@ -8,5 +8,5 @@ Your OpenStack environment now includes the heat service. To add more services, see the `additional documentation on installing OpenStack `_ . -To learn more about the heat service, read the `Heat developer documentation -`__. +To learn more about the heat service, read the :doc:`Heat documentation +<../index>`. diff --git a/doc/source/operating_guides/scale_deployment.rst b/doc/source/operating_guides/scale_deployment.rst index 9f879f8394..efb025dae3 100644 --- a/doc/source/operating_guides/scale_deployment.rst +++ b/doc/source/operating_guides/scale_deployment.rst @@ -33,9 +33,8 @@ This guide, using a devstack installation of OpenStack, assumes that: 1. You have configured devstack from `Single Machine Installation Guide `_; - 2. You have set up heat on devstack, as defined at `heat and DevStack - `_; + 2. You have set up heat on devstack, as defined at :doc:`heat and DevStack + <../getting_started/on_devstack>`; 3. You have installed `HAProxy `_ on the devstack server. @@ -48,11 +47,10 @@ used and the target scaled out architecture. Basic Architecture ------------------ -The heat architecture is as defined at `heat architecture -`_ and shown in the -diagram below, where we have a CLI that sends HTTP requests to the REST and CFN -APIs, which in turn make calls using AMQP to the heat-engine. -:: +The heat architecture is as defined at :doc:`heat architecture +<../developing_guides/architecture>` and shown in the diagram below, +where we have a CLI that sends HTTP requests to the REST and CFN APIs, which in +turn make calls using AMQP to the heat-engine:: |- [REST API] -| [CLI] -- -- -- -- [ENGINE] diff --git a/doc/source/template_guide/hello_world.rst b/doc/source/template_guide/hello_world.rst index 56bbcb6f1d..414907c998 100644 --- a/doc/source/template_guide/hello_world.rst +++ b/doc/source/template_guide/hello_world.rst @@ -51,10 +51,10 @@ could be used to deploy a single compute instance: image: ubuntu-trusty-x86_64 flavor: m1.small -Each HOT template must include the ``heat_template_version`` key with -the HOT version value, for example, ``2013-05-23``. A list of HOT template -versions can be found at `Heat Template Version -file `__ +Each HOT template must include the ``heat_template_version`` key with the HOT +version value, for example, ``2013-05-23``. Consult the :ref:`Heat template +version list ` for allowed values and their +features. The ``description`` key is optional, however it is good practice to include some useful text that describes what users can do with the template.