From 60069b02769bfec639247661aa3ddf8cca900995 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Fri, 26 Jul 2019 15:58:27 +0200 Subject: [PATCH] Fix links - and make them robust There's no .md file in here, so change links. Looking at the used links, these are all external links and thus sphinx cannot test whether they work. Use internal links so that all links work - and work even after renames. This shows up as e.g.: WARNING: unknown document: install-maas.html Update tox.ini so that these are hard errors. Remove dead requirement oslosphinx, it's not needed anymore here since openstackdocstheme is used. Change-Id: Ieae398aecb48c2e26de5c50261e700f8790e64ce --- deploy-guide/source/install-juju.rst | 4 ++-- deploy-guide/source/install-maas.rst | 2 ++ deploy-guide/source/install-openstack-bundle.rst | 6 +++--- deploy-guide/source/install-openstack.rst | 16 +++++++++------- requirements.txt | 1 - tox.ini | 2 +- 6 files changed, 17 insertions(+), 14 deletions(-) diff --git a/deploy-guide/source/install-juju.rst b/deploy-guide/source/install-juju.rst index 854061c..2db43b0 100644 --- a/deploy-guide/source/install-juju.rst +++ b/deploy-guide/source/install-juju.rst @@ -5,7 +5,7 @@ Install Juju tool that allows you to deploy, configure, scale and operate your software on public and private clouds. -In the `previous step <./install-maas.html>`__, we installed, deployed and +In the :doc:`previous step `, we installed, deployed and configured `MAAS `__ to use as a foundation for Juju to deploy a fully fledged OpenStack cloud. @@ -109,7 +109,7 @@ controller for our cloud: The constraint in the above command will ask MAAS to use any nodes tagged with ``juju`` to host the controller for the Juju client. We tagged this node within -MAAS in the `previous step <./install-maas.md#commision-nodes>`__. +MAAS in the :ref:`previous step `. The output to a successful bootstrap will look similar to the following: diff --git a/deploy-guide/source/install-maas.rst b/deploy-guide/source/install-maas.rst index e5162f6..f2d0740 100644 --- a/deploy-guide/source/install-maas.rst +++ b/deploy-guide/source/install-maas.rst @@ -260,6 +260,8 @@ configuration may require. Click ``Save changes`` when finished. You should now be able to power off the machine using the ``Take action`` menu in the top right. +.. _commision_nodes: + Commission nodes ---------------- diff --git a/deploy-guide/source/install-openstack-bundle.rst b/deploy-guide/source/install-openstack-bundle.rst index 446dbd7..153e447 100644 --- a/deploy-guide/source/install-openstack-bundle.rst +++ b/deploy-guide/source/install-openstack-bundle.rst @@ -1,7 +1,7 @@ Install OpenStack from a bundle =============================== -`Stepping through the deployment <./install-openstack.html>`__ of each OpenStack +:doc:`Stepping through the deployment ` of each OpenStack application is the best way to understanding how OpenStack and Juju operate, and how each application relates to one another. But it's a labour intensive process. @@ -34,9 +34,9 @@ Monitor the output of ``juju status`` to see when everything is ready. Next steps ---------- -See the `Install OpenStack <./install-openstack.md#test-openstack>`__ +See the :ref:`Install OpenStack ` documentation for details on testing your OpenStack deployment, or jump directly -to `Configure OpenStack <./config-openstack.html>`__ to start using OpenStack +to :doc:`Configure OpenStack ` to start using OpenStack productively as quickly as possible. .. raw:: html diff --git a/deploy-guide/source/install-openstack.rst b/deploy-guide/source/install-openstack.rst index 26a3d5a..a1e63a7 100644 --- a/deploy-guide/source/install-openstack.rst +++ b/deploy-guide/source/install-openstack.rst @@ -1,8 +1,8 @@ Install OpenStack ================= -Now that we've installed and configured `MAAS <./install-maas.html>`__ and -successfully deployed a `Juju <./install-juju.html>`__ controller, it's time to +Now that we've installed and configured :doc:`MAAS ` and +successfully deployed a :doc:`Juju ` controller, it's time to do some real work; use Juju to deploy `OpenStack `__, the leading open cloud platform. @@ -23,14 +23,14 @@ recommend starting with the first option. This will give you a stronger foundation for maintaining and expanding the default deployment. Our instructions for this option continue below. -Alternatively, jump to `Deploying OpenStack as a -bundle <./install-openstack-bundle.html>`__ to learn about deploying as a +Alternatively, jump to :doc:`Deploying OpenStack as a +bundle ` to learn about deploying as a bundle. Deploy the Juju controller -------------------------- -`Previously <./install-juju.html>`__, we tested our MAAS and Juju configuration +:doc:`Previously `, we tested our MAAS and Juju configuration by deploying a new Juju controller called ``maas-controller``. You can check this controller is still operational by typing ``juju status``. With the Juju controller running, the output will look similar to the following: @@ -497,6 +497,8 @@ All that's now left to do is wait on the output from ``juju status`` to show when everything is ready (everything turns green, if your terminal support colour). +.. _test_openstack: + Test OpenStack -------------- @@ -525,8 +527,8 @@ Next steps ---------- Congratulations, you've successfully deployed a working OpenStack environment -using both Juju and MAAS. The next step is to `configure -OpenStack <./config-openstack.html>`__ for use within a production environment. +using both Juju and MAAS. The next step is to :doc:`configure +OpenStack ` for use within a production environment. .. raw:: html diff --git a/requirements.txt b/requirements.txt index 9ea2dbc..4c02c23 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,3 @@ sphinx>=1.1.2,!=1.2.0,!=1.3b1,<1.3 # BSD -oslosphinx>=2.5.0,!=3.4.0 # Apache-2.0 pbr>=1.6 # Apache-2.0 openstackdocstheme>=1.5.0,<1.18.0 # Apache-2.0 diff --git a/tox.ini b/tox.ini index dd9a622..47c2f28 100644 --- a/tox.ini +++ b/tox.ini @@ -15,4 +15,4 @@ basepython = python3 commands = {posargs} [testenv:deploy-guide] -commands = sphinx-build -a -d deploy-guide/build/doctrees -b html deploy-guide/source deploy-guide/build/html +commands = sphinx-build -a -W -d deploy-guide/build/doctrees -b html deploy-guide/source deploy-guide/build/html