starlingx/docs
Code Issues Proposed changes

Changed relative paths to absolute

Browse Source 
Sphinx considers the "source" dir to be it's root. Image or figure paths such as:

.. image:: ../deploy_install_guides/r5_release/figures/starlingx-deployment-options-controller-storage.png

can lead to build time behavior like the following under some circumstances:

copying images... [ 11%] deploy/../deploy_install_guides/r5_release/figures/starlingx-deployment-options-controller-storage.png

whereas the absolute path:

.. image:: /deploy_install_guides/r5_release/figures/starlingx-deployment-options-controller-storage.png

behaves predictably.

copying images... [ 11%] /deploy_install_guides/r5_release/figures/starlingx-deployment-options-controller-storage.png

So changed a handful of relative links to be absolute from the source root.

Signed-off-by: Stone <ronald.stone@windriver.com>
Change-Id: Id63e5949a78959a5f570b835eac658b42440fbcd
This commit is contained in:
Stone
2021-02-19 06:30:40 -05:00
parent 5a7ec8c408
commit 333b4346aa
4 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/deploy/deployment-and-configuration-options-standard-configuration-with-controller-storage.rst
View File

@@ -10,7 +10,7 @@ Standard Configuration with Controller Storage
back-end for Kubernetes |PVCs| deployed on the
controller nodes instead of using dedicated storage nodes.
.. image:: ../deploy_install_guides/r5_release/figures/starlingx-deployment-options-controller-storage.png
.. image:: /deploy_install_guides/r5_release/figures/starlingx-deployment-options-controller-storage.png
:width: 800
.. note::

4
doc/source/deploy/deployment-config-options-all-in-one-duplex-configuration.rst
View File

@@ -14,7 +14,7 @@ redundant pair of hosts.
:local:
:depth: 1
.. image:: ../deploy_install_guides/r5_release/figures/starlingx-deployment-options-duplex.png
.. image:: /deploy_install_guides/r5_release/figures/starlingx-deployment-options-duplex.png
:width: 800
See :ref:`Common Components <common-components>` for a description of common
@@ -94,7 +94,7 @@ Up to fifty worker/compute nodes can be added to the All-in-one Duplex
deployment, allowing a capacity growth path if starting with an AIO-Duplex
deployment.
.. image:: ../deploy_install_guides/r5_release/figures/starlingx-deployment-options-duplex-extended.png
.. image:: /deploy_install_guides/r5_release/figures/starlingx-deployment-options-duplex-extended.png
:width: 800
The extended capacity is limited up to fifty worker/compute nodes as the

2
doc/source/deploy/deployment-config-optionsall-in-one-simplex-configuration.rst
View File

@@ -10,7 +10,7 @@ The AIO Simplex deployment configuration provides a scaled-down |prod| that
combines controller, storage, and worker functionality on a single
non-redundant host.
.. image:: ../deploy_install_guides/r5_release/figures/starlingx-deployment-options-simplex.png
.. image:: /deploy_install_guides/r5_release/figures/starlingx-deployment-options-simplex.png
:width: 800
.. note::

2
doc/source/deploy/standard-configuration-with-dedicated-storage.rst
View File

@@ -9,7 +9,7 @@ Standard Configuration with Dedicated Storage
Deployment of |prod| with dedicated storage nodes provides the highest capacity
\(single region\), performance, and scalability.
.. image:: ../deploy_install_guides/r5_release/figures/starlingx-deployment-options-dedicated-storage.png
.. image:: /deploy_install_guides/r5_release/figures/starlingx-deployment-options-dedicated-storage.png
:width: 800
.. note::