Fix for broken links on Installation and Deployment Guides page(s)

- Updated links in index to use toctrees so that Sphinx can resolve URLs correctly.
- Moved docs linked from new Installation and Deployment Guides page into same
deploy_install_guides folder.
- Updated broken links resulting from file moves.
- Removed extra folders for consistency between versions.
- Updated a couple page titles to use new R2.0 version convention.

Change-Id: Ib57a79d27411e2818569e0ded87fa393dff10075
Signed-off-by: Kristal Dale <kristal.dale@intel.com>

doc/source/deploy_install_guides/current/index.rst

@@ -5,7 +5,7 @@ Installation guide stx.2018.10
 This is the installation guide for the "current" StarlingX software
 (i.e. the most recently released version).
 If this is not the installation guide you want to use, see the
-:doc:`available installation guides </installation_guide/index>`.
+:doc:`available installation guides </deploy_install_guides/index>`.
 
 ------------
 Introduction
@@ -20,7 +20,7 @@ StarlingX may be installed in:
 
 StarlingX installed in virtual environments has two options:
 
-- :doc:`Libvirt/QEMU </installation_guide/current/installation_libvirt_qemu>`
+- :doc:`Libvirt/QEMU <installation_libvirt_qemu>`
 - VirtualBox
 
 ------------
@@ -271,13 +271,13 @@ Deployment options
 
 -  Standard controller
 
-   - :doc:`StarlingX Cloud with Dedicated Storage </deployment_guides/current/dedicated_storage>`
-   - :doc:`StarlingX Cloud with Controller Storage </deployment_guides/current/controller_storage>`
+   - :doc:`StarlingX Cloud with Dedicated Storage </deploy_install_guides/current/dedicated_storage>`
+   - :doc:`StarlingX Cloud with Controller Storage </deploy_install_guides/current/controller_storage>`
 
 -  All-in-one
 
-   - :doc:`StarlingX Cloud Duplex </deployment_guides/current/duplex>`
-   - :doc:`StarlingX Cloud Simplex </deployment_guides/current/simplex>`
+   - :doc:`StarlingX Cloud Duplex </deploy_install_guides/current/duplex>`
+   - :doc:`StarlingX Cloud Simplex </deploy_install_guides/current/simplex>`
 
 .. toctree::
    :hidden:

doc/source/deploy_install_guides/current/installation_libvirt_qemu.rst

@@ -195,10 +195,10 @@ controller-0 step.
 
 -  Standard controller
 
-   - :doc:`StarlingX Cloud with Dedicated Storage Virtual Environment </deployment_guides/current/dedicated_storage>`
-   - :doc:`StarlingX Cloud with Controller Storage Virtual Environment </deployment_guides/current/controller_storage>`
+   - :doc:`StarlingX Cloud with Dedicated Storage Virtual Environment </deploy_install_guides/current/dedicated_storage>`
+   - :doc:`StarlingX Cloud with Controller Storage Virtual Environment </deploy_install_guides/current/controller_storage>`
 
 -  All-in-one
 
-   - :doc:`StarlingX Cloud Duplex Virtual Environment </deployment_guides/current/duplex>`
-   - :doc:`StarlingX Cloud Simplex Virtual Environment </deployment_guides/current/simplex>`
+   - :doc:`StarlingX Cloud Duplex Virtual Environment </deploy_install_guides/current/duplex>`
+   - :doc:`StarlingX Cloud Simplex Virtual Environment </deploy_install_guides/current/simplex>`

doc/source/deploy_install_guides/index.rst

@@ -5,8 +5,7 @@ Installation and Deployment Guides
 .. toctree::
    :hidden:
 
-   latest/aio_simplex/index
-   latest/aio_duplex/index
+   upcoming/installation_libvirt_qemu
 
 
 Installation and deployment guides for StarlingX are release-specific.
@@ -24,16 +23,22 @@ released version of StarlingX.
 Installation guide
 ^^^^^^^^^^^^^^^^^^
 
-- `Installation stx.2018.10 <../../html/installation_guide/current/index.html>`__
+.. toctree::
+   :maxdepth: 1
+
+   current/index
 
 ^^^^^^^^^^^^^^^^^
 Deployment guides
 ^^^^^^^^^^^^^^^^^
 
-- `All-in-one simplex stx.2018.10 <../../html/deployment_guides/current/simplex.html>`__
-- `All-in-one duplex stx.2018.10 <../../html/deployment_guides/current/duplex.html>`__
-- `Controller storage stx.2018.10 <../../html/deployment_guides/current/controller_storage.html>`__
-- `Dedicated storage stx.2018.10 <../../html/deployment_guides/current/dedicated_storage.html>`__
+.. toctree::
+   :maxdepth: 1
+
+   current/simplex
+   current/duplex
+   current/controller_storage
+   current/dedicated_storage
 
 ****************
 Upcoming release
@@ -45,20 +50,26 @@ The upcoming release is the forthcoming version under development.
 Deployment planning
 ^^^^^^^^^^^^^^^^^^^
 
-- `Deployment planning <../../html/deployment_guides/latest/planning/index.html>`__
-- `Deployment options <../../html/deployment_guides/latest/options/index.html>`__
+.. toctree::
+   :maxdepth: 1
+
+   upcoming/planning
+   upcoming/options
 
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Installation and deployment guides
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-- `All-in-one simplex R2.0 <../../html/deploy_install_guides/latest/aio_simplex/index.html>`__
-- `All-in-one duplex R2.0 <../../html/deploy_install_guides/latest/aio_duplex/index.html>`__
-- `Standard controller storage R2.0 <../../html/deploy_install_guides/latest/controller_storage/index.html>`__
-- `Standard dedicated storage R2.0 <../../html/deploy_install_guides/latest/dedicated_storage/index.html>`__
-- `Standard with Ironic <../../html/deployment_guides/latest/ironic/index.html>`__
-- `Multi-region <../../html/deployment_guides/latest/multi_region/index.html>`__
-- `Distributed cloud <../../html/deployment_guides/latest/dist_cloud/index.html>`__
+.. toctree::
+   :maxdepth: 1
+
+   upcoming/aio_simplex
+   upcoming/aio_duplex
+   upcoming/controller_storage
+   upcoming/dedicated_storage
+   upcoming/ironic
+   upcoming/multi_region
+   upcoming/dist_cloud
 
 *****************
 Archived releases

doc/source/deploy_install_guides/upcoming/aio_duplex.rst

@@ -24,7 +24,7 @@ on two physical servers.
 With these cloud functions, multiple application types can be deployed and
 consolidated onto a protected pair of physical servers.
 
-.. figure:: ../figures/starlingx-deployment-options-duplex.png
+.. figure:: figures/starlingx-deployment-options-duplex.png
    :scale: 90%
    :alt: All-In-One Simplex deployment configuration
 
@@ -69,7 +69,7 @@ someone starting with an All-in-one duplex standard configuration option.
 With this option, virtual machines can be scheduled on either of the
 all-in-one controller nodes, the compute nodes, or both.
 
-.. figure:: ../figures/starlingx-deployment-options-duplex-extended.png
+.. figure:: figures/starlingx-deployment-options-duplex-extended.png
    :scale: 90%
    :alt: All-in-one duplex extended configuration
 
@@ -93,7 +93,7 @@ You can install StarlingX in the following:
 
 Furthermore, StarlingX installed in virtual environments has a single option:
 
-- :doc:`Libvirt/QEMU </installation_guide/latest/installation_libvirt_qemu>`
+- :doc:`Libvirt/QEMU <installation_libvirt_qemu>`
 
 ------------
 Requirements
@@ -1226,15 +1226,15 @@ Deployment and installation terminology
 
 Following are terms used when describing the AIO-SX deployment and installation.
 
-.. include:: ../deployment_terminology.rst
+.. include:: deployment_terminology.rst
    :start-after: incl-simplex-deployment-terminology:
    :end-before: incl-simplex-deployment-terminology-end:
 
-.. include:: ../deployment_terminology.rst
+.. include:: deployment_terminology.rst
    :start-after: incl-standard-controller-deployment-terminology:
    :end-before: incl-standard-controller-deployment-terminology-end:
 
-.. include:: ../deployment_terminology.rst
+.. include:: deployment_terminology.rst
    :start-after: incl-common-deployment-terminology:
    :end-before: incl-common-deployment-terminology-end:
 

doc/source/deploy_install_guides/upcoming/aio_simplex.rst

@@ -31,7 +31,7 @@ Only a small amount of cloud processing / storage power is required with an
 All-In-One Simplex deployment.
 
 
-.. figure:: ../figures/starlingx-deployment-options-simplex.png
+.. figure:: figures/starlingx-deployment-options-simplex.png
    :scale: 50%
    :alt: All-In-One Simplex deployment configuration
 
@@ -57,7 +57,7 @@ StarlingX may be installed in:
 
 Furthermore, StarlingX installed in virtual environments has a single option:
 
-- :doc:`Libvirt/QEMU </installation_guide/latest/installation_libvirt_qemu>`
+- :doc:`Libvirt/QEMU <installation_libvirt_qemu>`
 
 ------------
 Requirements
@@ -1073,15 +1073,15 @@ Deployment and installation terminology
 
 Following are terms used when describing the AIO-SX deployment and installation.
 
-.. include:: ../deployment_terminology.rst
+.. include:: deployment_terminology.rst
    :start-after: incl-simplex-deployment-terminology:
    :end-before: incl-simplex-deployment-terminology-end:
 
-.. include:: ../deployment_terminology.rst
+.. include:: deployment_terminology.rst
    :start-after: incl-standard-controller-deployment-terminology:
    :end-before: incl-standard-controller-deployment-terminology-end:
 
-.. include:: ../deployment_terminology.rst
+.. include:: deployment_terminology.rst
    :start-after: incl-common-deployment-terminology:
    :end-before: incl-common-deployment-terminology-end:
 

doc/source/deploy_install_guides/upcoming/controller_storage.rst

@@ -1,6 +1,6 @@
-==============================
-Controller storage stx.2019.05
-==============================
+=======================
+Controller storage R2.0
+=======================
 
 .. contents::
    :local:
@@ -28,7 +28,7 @@ controller / storage cluster with:
 - Storage function running on top of LVM on single second disk, DRBD-sync'd
   between the controller nodes.
 
-.. figure:: ../figures/starlingx-deployment-options-controller-storage.png
+.. figure:: figures/starlingx-deployment-options-controller-storage.png
    :scale: 50%
    :alt: Controller Storage deployment configuration
 
@@ -965,10 +965,10 @@ virtual machines.
 Deployment terminology
 ----------------------
 
-.. include:: ../deployment_terminology.rst
+.. include:: deployment_terminology.rst
    :start-after: incl-standard-controller-deployment-terminology:
    :end-before: incl-standard-controller-deployment-terminology-end:
 
-.. include:: ../deployment_terminology.rst
+.. include:: deployment_terminology.rst
    :start-after: incl-common-deployment-terminology:
    :end-before: incl-common-deployment-terminology-end:

doc/source/deploy_install_guides/upcoming/dedicated_storage.rst

@@ -1,6 +1,6 @@
-=============================
-Dedicated storage stx.2019.05
-=============================
+======================
+Dedicated storage R2.0
+======================
 
 .. contents::
    :local:
@@ -23,7 +23,7 @@ This deployment option provides the maximum capacity for a single region
 deployment, with a supported growth path to a multi-region deployment option by
 adding a secondary region.
 
-.. figure:: ../figures/starlingx-deployment-options-dedicated-storage.png
+.. figure:: figures/starlingx-deployment-options-dedicated-storage.png
    :scale: 50%
    :alt: Dedicated Storage deployment configuration
 
@@ -917,14 +917,14 @@ launch Nova virtual machines.
 Deployment terminology
 ----------------------
 
-.. include:: ../deployment_terminology.rst
+.. include:: deployment_terminology.rst
    :start-after: incl-standard-controller-deployment-terminology:
    :end-before: incl-standard-controller-deployment-terminology-end:
 
-.. include:: ../deployment_terminology.rst
+.. include:: deployment_terminology.rst
    :start-after: incl-dedicated-storage-deployment-terminology:
    :end-before: incl-dedicated-storage-deployment-terminology-end:
 
-.. include:: ../deployment_terminology.rst
+.. include:: deployment_terminology.rst
    :start-after: incl-common-deployment-terminology:
    :end-before: incl-common-deployment-terminology-end:

doc/source/deploy_install_guides/upcoming/installation_libvirt_qemu.rst

@@ -1,8 +1,8 @@
-=====================================
-Installation libvirt qemu stx.2019.05
-=====================================
+==============================
+Installation libvirt qemu R2.0
+==============================
 
-Installation for StarlingX stx.2019.05 using Libvirt/QEMU virtualization.
+Installation for StarlingX R2.0 using Libvirt/QEMU virtualization.
 
 ---------------------
 Hardware requirements
@@ -202,11 +202,9 @@ process from the "initializing controller-0" step.
 
 -  Standard controller
 
-   - :doc:`StarlingX Cloud with Dedicated Storage Virtual Environment </deployment_guides/latest/dedicated_storage/index>`
-   - :doc:`StarlingX Cloud with Controller Storage Virtual Environment </deployment_guides/latest/controller_storage/index>`
+   .. "Latest" Controller and Dedicated storage moved to Installation and Deployment Guides - upcoming.
 
 -  All-in-one
 
-   - :doc:`StarlingX Cloud Duplex Virtual Environment </deploy_install_guides/latest/aio_duplex/index>`
-   - :doc:`StarlingX Cloud Simplex Virtual Environment </deploy_install_guides/latest/aio_simplex/index>`
+   .. "Latest" aio-simplex and aio-duplex moved to Installation and Deployment Guides - upcoming.
 

doc/source/deployment_guides/index.rst

@@ -6,15 +6,8 @@ Deployment guides for StarlingX are release-specific.
 The following list provides help on choosing the correct deployment guide:
 
 - The "current" release is the most recent officially released version of StarlingX.
-  Following are the current deployment guides:
 
-  .. toctree::
-     :maxdepth: 1
-
-     ../deployment_guides/current/simplex
-     ../deployment_guides/current/duplex
-     ../deployment_guides/current/controller_storage
-     ../deployment_guides/current/dedicated_storage
+.. "Current" deployment guides moved to Installation and Deployment Guides.
 
 - The "latest" release is the forthcoming version under development.
   Following are the latest deployment guides:
@@ -22,16 +15,9 @@ The following list provides help on choosing the correct deployment guide:
   .. toctree::
      :maxdepth: 1
 
-     latest/planning/index
-     latest/options/index
-     ../deploy_install_guides/latest/aio_simplex/index
-     ../deploy_install_guides/latest/aio_duplex/index
      latest/aio_duplex_computes/index
-     latest/controller_storage/index
-     latest/dedicated_storage/index
-     latest/ironic/index
-     latest/multi_region/index
-     latest/dist_cloud/index
+
+ .. All other "Latest" deployment guides moved to Installation and Deployment Guides.
 
 - Following are deployment guides for past StartlingX releases that have
   been archived:

doc/source/deployment_guides/latest/deployment_terminology.rst

@@ -1,119 +0,0 @@
-.. _incl-simplex-deployment-terminology:
-
-**All-in-one controller node**
-    A single physical node that provides a controller function, compute
-    function, and storage function.
-
-.. _incl-simplex-deployment-terminology-end:
-
-
-.. _incl-standard-controller-deployment-terminology:
-
-**Controller node / function**
-    A node that runs cloud control function for managing cloud resources.
-
-    - Runs cloud control functions for managing cloud resources.
-    - Runs all OpenStack control functions (e.g. managing images, virtual
-      volumes, virtual network, and virtual machines).
-    - Can be part of a two-node HA control node cluster for running control
-      functions either active/active or active/standby.
-
-**Compute ( & network ) node / function**
-    A node that hosts applications in virtual machines using compute resources
-    such as CPU, memory, and disk.
-
-    - Runs virtual switch for realizing virtual networks.
-    - Provides L3 routing and NET services.
-
-.. _incl-standard-controller-deployment-terminology-end:
-
-
-.. _incl-dedicated-storage-deployment-terminology:
-
-**Storage node / function**
-    A node that contains a set of disks (e.g. SATA, SAS, SSD, and/or NVMe).
-
-    - Runs CEPH distributed storage software.
-    - Part of an HA multi-node CEPH storage cluster supporting a replication
-      factor of two or three, journal caching, and class tiering.
-    - Provides HA persistent storage for images, virtual volumes
-      (i.e. block storage), and object storage.
-
-.. _incl-dedicated-storage-deployment-terminology-end:
-
-.. _incl-common-deployment-terminology:
-
-**OAM network**
-    The network on which all external StarlingX platform APIs are exposed,
-    (i.e. REST APIs, Horizon web server, SSH, and SNMP), typically 1GE.
-
-    Only controller type nodes are required to be connected to the OAM
-    network.
-
-**Management network**
-    A private network (i.e. not connected externally), tipically 10GE,
-    used for the following:
-
-    - Internal OpenStack / StarlingX monitoring and control.
-    - VM I/O access to a storage cluster.
-
-    All nodes are required to be connected to the management network.
-
-**Data network(s)**
-    Networks on which the OpenStack / Neutron provider networks are realized
-    and become the VM tenant networks.
-
-    Only compute type and all-in-one type nodes are required to be connected
-    to the data network(s); these node types require one or more interface(s)
-    on the data network(s).
-
-**IPMI network**
-    An optional network on which IPMI interfaces of all nodes are connected.
-    The network must be reachable using L3/IP from the controller's OAM
-    interfaces.
-
-    You can optionally connect all node types to the IPMI network.
-
-**PXEBoot network**
-    An optional network for controllers to boot/install other nodes over the
-    network.
-
-    By default, controllers use the management network for boot/install of other
-    nodes in the openstack cloud. If this optional network is used, all node
-    types are required to be connected to the PXEBoot network.
-
-    A PXEBoot network is required for a variety of special case situations:
-
-    - Cases where the management network must be IPv6:
-
-      - IPv6 does not support PXEBoot. Therefore, IPv4 PXEBoot network must be
-        configured.
-
-    - Cases where the management network must be VLAN tagged:
-
-      - Most server's BIOS do not support PXEBooting over tagged networks.
-        Therefore, you must configure an untagged PXEBoot network.
-
-    - Cases where a management network must be shared across regions but
-      individual regions' controllers want to only network boot/install nodes
-      of their own region:
-
-      - You must configure separate, per-region PXEBoot networks.
-
-**Infra network**
-    A deprecated optional network that was historically used for access to the
-    storage cluster.
-
-    If this optional network is used, all node types are required to be
-    connected to the INFRA network,
-
-**Node interfaces**
-    All nodes' network interfaces can, in general, optionally be either:
-
-    - Untagged single port.
-    - Untagged two-port LAG and optionally split between redudant L2 switches
-      running vPC (Virtual Port-Channel), also known as multichassis
-      EtherChannel (MEC).
-    - VLAN on either single-port ETH interface or two-port LAG interface.
-
-.. _incl-common-deployment-terminology-end:

doc/source/installation_guide/index.rst

@@ -7,10 +7,7 @@ The following list provides help on choosing the correct installation steps:
 
 - The "current" release is the most recent officially released version of StarlingX:
 
-  .. toctree::
-     :maxdepth: 1
-
-     /installation_guide/current/index
+.. "Current" installation guide moved to Installation and Deployment Guides.
 
 - The "latest" release is the forthcoming version under development:
 
@@ -18,8 +15,6 @@ The following list provides help on choosing the correct installation steps:
      :maxdepth: 1
 
      /installation_guide/latest/index
-     ../deploy_install_guides/latest/aio_simplex/index
-     ../deploy_install_guides/latest/aio_duplex/index
 
 - The "archived" installation documents are as follows:
 

doc/source/installation_guide/latest/index.rst

@@ -20,7 +20,9 @@ You can install StarlingX in the following:
 
 StarlingX installed in virtual environments has two options:
 
-- :doc:`Libvirt/QEMU </installation_guide/latest/installation_libvirt_qemu>`
+.. "Latest" libvirt qemu moved to Installation and Deployment Guides - upcoming.
+
+- Libvirt QEMU
 - VirtualBox
 
 ------------
@@ -159,8 +161,10 @@ depend on how long the installation was running, as this example uses
 thin qcow2 disks (which would fill up over time, but initially use much
 less than the virtual size).
 
+.. "Latest" libvirt qemu moved to Installation and Deployment Guides - upcoming.
+
 For example, in a
-:doc:`Libvirt/QEMU </installation_guide/latest/installation_libvirt_qemu>`
+Libvirt/QEMU
 environment, and an AIO-SX mode, the following are required when using the
 setup scripts and default XML definition file.
 
@@ -307,7 +311,8 @@ directory:
   additional_os_services
   multi_region
   dist_cloud
-  installation_libvirt_qemu
+
+.. "Latest" libvirt qemu moved to Installation and Deployment Guides - upcoming.
 
 ------------------
 Deployment options
@@ -315,19 +320,21 @@ Deployment options
 
 -  All-in-one
 
-   - :doc:`StarlingX Cloud Simplex <../../deploy_install_guides/latest/aio_simplex/index>`
-   - :doc:`StarlingX Cloud Duplex <../../deploy_install_guides/latest/aio_duplex/index>`
+.. "Latest" aio simplex and aio duplex moved to Installation and Deployment Guides - upcoming.
+
+
+   - AIO Simplex
+   - AIO Duplex
    - :doc:`StarlingX Cloud Duplex with Computes </deployment_guides/latest/aio_duplex_computes/index>`
 
 -  Standard controller
 
-   - :doc:`StarlingX Cloud with Controller Storage </deployment_guides/latest/controller_storage/index>`
-   - :doc:`StarlingX Cloud with Dedicated Storage </deployment_guides/latest/dedicated_storage/index>`
+.. "Latest" Controller and Dedicated storage moved to Installation and Deployment Guides - upcoming.
 
 -  Others
 
-   - :doc:`Multi-region </deployment_guides/latest/multi_region/index>`
-   - :doc:`Distributed cloud </deployment_guides/latest/dist_cloud/index>`
+.. "Latest" multi region and dist cloud moved to Installation and Deployment Guides - upcoming.
+
    - :doc:`Additional OpenStack services <additional_os_services>`