diff --git a/doc/source/contributor/build_guides/current/index.rst b/doc/source/contributor/build_guides/r2_release/index.rst similarity index 100% rename from doc/source/contributor/build_guides/current/index.rst rename to doc/source/contributor/build_guides/r2_release/index.rst diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst index 950820f35..bf0990214 100644 --- a/doc/source/contributor/index.rst +++ b/doc/source/contributor/index.rst @@ -39,7 +39,7 @@ guides for StarlingX are release-specific). .. toctree:: :maxdepth: 1 - build_guides/current/index + build_guides/r2_release/index build_guides/r1_release/index -------------------- diff --git a/doc/source/deploy_install_guides/index.rst b/doc/source/deploy_install_guides/index.rst index 2762bd9f7..7550025ac 100755 --- a/doc/source/deploy_install_guides/index.rst +++ b/doc/source/deploy_install_guides/index.rst @@ -15,7 +15,7 @@ StarlingX R2.0 is the latest officially released version of StarlingX. .. toctree:: :maxdepth: 1 - current/index + r2_release/index --------------------- Upcoming R3.0 release diff --git a/doc/source/deploy_install_guides/r1_release/index.rst b/doc/source/deploy_install_guides/r1_release/index.rst index db9ed742a..937ae07fc 100644 --- a/doc/source/deploy_install_guides/r1_release/index.rst +++ b/doc/source/deploy_install_guides/r1_release/index.rst @@ -242,7 +242,7 @@ Unload firewall and disable firewall on boot: Getting the StarlingX ISO image ------------------------------- -Follow the instructions from the :doc:`/contributor/build_guides/current/index` to build a +Follow the instructions from the :doc:`/contributor/build_guides/r1_release/index` to build a StarlingX ISO image. ********** diff --git a/doc/source/deploy_install_guides/current/bare_metal/aio_duplex.rst b/doc/source/deploy_install_guides/r2_release/bare_metal/aio_duplex.rst similarity index 100% rename from doc/source/deploy_install_guides/current/bare_metal/aio_duplex.rst rename to doc/source/deploy_install_guides/r2_release/bare_metal/aio_duplex.rst diff --git a/doc/source/deploy_install_guides/current/bare_metal/aio_duplex_extend.rst b/doc/source/deploy_install_guides/r2_release/bare_metal/aio_duplex_extend.rst similarity index 100% rename from doc/source/deploy_install_guides/current/bare_metal/aio_duplex_extend.rst rename to doc/source/deploy_install_guides/r2_release/bare_metal/aio_duplex_extend.rst diff --git a/doc/source/deploy_install_guides/current/bare_metal/aio_duplex_hardware.rst b/doc/source/deploy_install_guides/r2_release/bare_metal/aio_duplex_hardware.rst similarity index 100% rename from doc/source/deploy_install_guides/current/bare_metal/aio_duplex_hardware.rst rename to doc/source/deploy_install_guides/r2_release/bare_metal/aio_duplex_hardware.rst diff --git a/doc/source/deploy_install_guides/current/bare_metal/aio_duplex_install_kubernetes.rst b/doc/source/deploy_install_guides/r2_release/bare_metal/aio_duplex_install_kubernetes.rst similarity index 100% rename from doc/source/deploy_install_guides/current/bare_metal/aio_duplex_install_kubernetes.rst rename to doc/source/deploy_install_guides/r2_release/bare_metal/aio_duplex_install_kubernetes.rst diff --git a/doc/source/deploy_install_guides/current/bare_metal/aio_simplex.rst b/doc/source/deploy_install_guides/r2_release/bare_metal/aio_simplex.rst similarity index 100% rename from doc/source/deploy_install_guides/current/bare_metal/aio_simplex.rst rename to doc/source/deploy_install_guides/r2_release/bare_metal/aio_simplex.rst diff --git a/doc/source/deploy_install_guides/current/bare_metal/aio_simplex_hardware.rst b/doc/source/deploy_install_guides/r2_release/bare_metal/aio_simplex_hardware.rst similarity index 100% rename from doc/source/deploy_install_guides/current/bare_metal/aio_simplex_hardware.rst rename to doc/source/deploy_install_guides/r2_release/bare_metal/aio_simplex_hardware.rst diff --git a/doc/source/deploy_install_guides/current/bare_metal/aio_simplex_install_kubernetes.rst b/doc/source/deploy_install_guides/r2_release/bare_metal/aio_simplex_install_kubernetes.rst similarity index 100% rename from doc/source/deploy_install_guides/current/bare_metal/aio_simplex_install_kubernetes.rst rename to doc/source/deploy_install_guides/r2_release/bare_metal/aio_simplex_install_kubernetes.rst diff --git a/doc/source/deploy_install_guides/current/bare_metal/ansible_bootstrap_configs.rst b/doc/source/deploy_install_guides/r2_release/bare_metal/ansible_bootstrap_configs.rst similarity index 100% rename from doc/source/deploy_install_guides/current/bare_metal/ansible_bootstrap_configs.rst rename to doc/source/deploy_install_guides/r2_release/bare_metal/ansible_bootstrap_configs.rst diff --git a/doc/source/deploy_install_guides/current/bare_metal/controller_storage.rst b/doc/source/deploy_install_guides/r2_release/bare_metal/controller_storage.rst similarity index 100% rename from doc/source/deploy_install_guides/current/bare_metal/controller_storage.rst rename to doc/source/deploy_install_guides/r2_release/bare_metal/controller_storage.rst diff --git a/doc/source/deploy_install_guides/current/bare_metal/controller_storage_hardware.rst b/doc/source/deploy_install_guides/r2_release/bare_metal/controller_storage_hardware.rst similarity index 100% rename from doc/source/deploy_install_guides/current/bare_metal/controller_storage_hardware.rst rename to doc/source/deploy_install_guides/r2_release/bare_metal/controller_storage_hardware.rst diff --git a/doc/source/deploy_install_guides/current/bare_metal/controller_storage_install_kubernetes.rst b/doc/source/deploy_install_guides/r2_release/bare_metal/controller_storage_install_kubernetes.rst similarity index 100% rename from doc/source/deploy_install_guides/current/bare_metal/controller_storage_install_kubernetes.rst rename to doc/source/deploy_install_guides/r2_release/bare_metal/controller_storage_install_kubernetes.rst diff --git a/doc/source/deploy_install_guides/current/bare_metal/dedicated_storage.rst b/doc/source/deploy_install_guides/r2_release/bare_metal/dedicated_storage.rst similarity index 100% rename from doc/source/deploy_install_guides/current/bare_metal/dedicated_storage.rst rename to doc/source/deploy_install_guides/r2_release/bare_metal/dedicated_storage.rst diff --git a/doc/source/deploy_install_guides/current/bare_metal/dedicated_storage_hardware.rst b/doc/source/deploy_install_guides/r2_release/bare_metal/dedicated_storage_hardware.rst similarity index 100% rename from doc/source/deploy_install_guides/current/bare_metal/dedicated_storage_hardware.rst rename to doc/source/deploy_install_guides/r2_release/bare_metal/dedicated_storage_hardware.rst diff --git a/doc/source/deploy_install_guides/current/bare_metal/dedicated_storage_install_kubernetes.rst b/doc/source/deploy_install_guides/r2_release/bare_metal/dedicated_storage_install_kubernetes.rst similarity index 100% rename from doc/source/deploy_install_guides/current/bare_metal/dedicated_storage_install_kubernetes.rst rename to doc/source/deploy_install_guides/r2_release/bare_metal/dedicated_storage_install_kubernetes.rst diff --git a/doc/source/deploy_install_guides/current/bare_metal/ironic.rst b/doc/source/deploy_install_guides/r2_release/bare_metal/ironic.rst similarity index 100% rename from doc/source/deploy_install_guides/current/bare_metal/ironic.rst rename to doc/source/deploy_install_guides/r2_release/bare_metal/ironic.rst diff --git a/doc/source/deploy_install_guides/current/bare_metal/ironic_hardware.rst b/doc/source/deploy_install_guides/r2_release/bare_metal/ironic_hardware.rst similarity index 100% rename from doc/source/deploy_install_guides/current/bare_metal/ironic_hardware.rst rename to doc/source/deploy_install_guides/r2_release/bare_metal/ironic_hardware.rst diff --git a/doc/source/deploy_install_guides/current/bare_metal/ironic_install.rst b/doc/source/deploy_install_guides/r2_release/bare_metal/ironic_install.rst similarity index 100% rename from doc/source/deploy_install_guides/current/bare_metal/ironic_install.rst rename to doc/source/deploy_install_guides/r2_release/bare_metal/ironic_install.rst diff --git a/doc/source/deploy_install_guides/current/bare_metal/prep_servers.txt b/doc/source/deploy_install_guides/r2_release/bare_metal/prep_servers.txt similarity index 100% rename from doc/source/deploy_install_guides/current/bare_metal/prep_servers.txt rename to doc/source/deploy_install_guides/r2_release/bare_metal/prep_servers.txt diff --git a/doc/source/deploy_install_guides/current/desc_aio_duplex.txt b/doc/source/deploy_install_guides/r2_release/desc_aio_duplex.txt similarity index 100% rename from doc/source/deploy_install_guides/current/desc_aio_duplex.txt rename to doc/source/deploy_install_guides/r2_release/desc_aio_duplex.txt diff --git a/doc/source/deploy_install_guides/current/desc_aio_simplex.txt b/doc/source/deploy_install_guides/r2_release/desc_aio_simplex.txt similarity index 100% rename from doc/source/deploy_install_guides/current/desc_aio_simplex.txt rename to doc/source/deploy_install_guides/r2_release/desc_aio_simplex.txt diff --git a/doc/source/deploy_install_guides/current/desc_controller_storage.txt b/doc/source/deploy_install_guides/r2_release/desc_controller_storage.txt similarity index 100% rename from doc/source/deploy_install_guides/current/desc_controller_storage.txt rename to doc/source/deploy_install_guides/r2_release/desc_controller_storage.txt diff --git a/doc/source/deploy_install_guides/current/desc_dedicated_storage.txt b/doc/source/deploy_install_guides/r2_release/desc_dedicated_storage.txt similarity index 100% rename from doc/source/deploy_install_guides/current/desc_dedicated_storage.txt rename to doc/source/deploy_install_guides/r2_release/desc_dedicated_storage.txt diff --git a/doc/source/deploy_install_guides/current/figures/starlingx-deployment-options-controller-storage.png b/doc/source/deploy_install_guides/r2_release/figures/starlingx-deployment-options-controller-storage.png similarity index 100% rename from doc/source/deploy_install_guides/current/figures/starlingx-deployment-options-controller-storage.png rename to doc/source/deploy_install_guides/r2_release/figures/starlingx-deployment-options-controller-storage.png diff --git a/doc/source/deploy_install_guides/current/figures/starlingx-deployment-options-dedicated-storage.png b/doc/source/deploy_install_guides/r2_release/figures/starlingx-deployment-options-dedicated-storage.png similarity index 100% rename from doc/source/deploy_install_guides/current/figures/starlingx-deployment-options-dedicated-storage.png rename to doc/source/deploy_install_guides/r2_release/figures/starlingx-deployment-options-dedicated-storage.png diff --git a/doc/source/deploy_install_guides/current/figures/starlingx-deployment-options-duplex-extended.png b/doc/source/deploy_install_guides/r2_release/figures/starlingx-deployment-options-duplex-extended.png similarity index 100% rename from doc/source/deploy_install_guides/current/figures/starlingx-deployment-options-duplex-extended.png rename to doc/source/deploy_install_guides/r2_release/figures/starlingx-deployment-options-duplex-extended.png diff --git a/doc/source/deploy_install_guides/current/figures/starlingx-deployment-options-duplex.png b/doc/source/deploy_install_guides/r2_release/figures/starlingx-deployment-options-duplex.png similarity index 100% rename from doc/source/deploy_install_guides/current/figures/starlingx-deployment-options-duplex.png rename to doc/source/deploy_install_guides/r2_release/figures/starlingx-deployment-options-duplex.png diff --git a/doc/source/deploy_install_guides/current/figures/starlingx-deployment-options-ironic.png b/doc/source/deploy_install_guides/r2_release/figures/starlingx-deployment-options-ironic.png similarity index 100% rename from doc/source/deploy_install_guides/current/figures/starlingx-deployment-options-ironic.png rename to doc/source/deploy_install_guides/r2_release/figures/starlingx-deployment-options-ironic.png diff --git a/doc/source/deploy_install_guides/current/figures/starlingx-deployment-options-simplex.png b/doc/source/deploy_install_guides/r2_release/figures/starlingx-deployment-options-simplex.png similarity index 100% rename from doc/source/deploy_install_guides/current/figures/starlingx-deployment-options-simplex.png rename to doc/source/deploy_install_guides/r2_release/figures/starlingx-deployment-options-simplex.png diff --git a/doc/source/deploy_install_guides/current/index.rst b/doc/source/deploy_install_guides/r2_release/index.rst similarity index 100% rename from doc/source/deploy_install_guides/current/index.rst rename to doc/source/deploy_install_guides/r2_release/index.rst diff --git a/doc/source/deploy_install_guides/current/ipv6_note.txt b/doc/source/deploy_install_guides/r2_release/ipv6_note.txt similarity index 100% rename from doc/source/deploy_install_guides/current/ipv6_note.txt rename to doc/source/deploy_install_guides/r2_release/ipv6_note.txt diff --git a/doc/source/deploy_install_guides/current/kubernetes_access.rst b/doc/source/deploy_install_guides/r2_release/kubernetes_access.rst similarity index 100% rename from doc/source/deploy_install_guides/current/kubernetes_access.rst rename to doc/source/deploy_install_guides/r2_release/kubernetes_access.rst diff --git a/doc/source/deploy_install_guides/current/kubernetes_install_next.txt b/doc/source/deploy_install_guides/r2_release/kubernetes_install_next.txt similarity index 100% rename from doc/source/deploy_install_guides/current/kubernetes_install_next.txt rename to doc/source/deploy_install_guides/r2_release/kubernetes_install_next.txt diff --git a/doc/source/deploy_install_guides/current/openstack/access.rst b/doc/source/deploy_install_guides/r2_release/openstack/access.rst similarity index 100% rename from doc/source/deploy_install_guides/current/openstack/access.rst rename to doc/source/deploy_install_guides/r2_release/openstack/access.rst diff --git a/doc/source/deploy_install_guides/current/openstack/index.rst b/doc/source/deploy_install_guides/r2_release/openstack/index.rst similarity index 100% rename from doc/source/deploy_install_guides/current/openstack/index.rst rename to doc/source/deploy_install_guides/r2_release/openstack/index.rst diff --git a/doc/source/deploy_install_guides/current/openstack/install.rst b/doc/source/deploy_install_guides/r2_release/openstack/install.rst similarity index 100% rename from doc/source/deploy_install_guides/current/openstack/install.rst rename to doc/source/deploy_install_guides/r2_release/openstack/install.rst diff --git a/doc/source/deploy_install_guides/current/openstack/uninstall_delete.rst b/doc/source/deploy_install_guides/r2_release/openstack/uninstall_delete.rst similarity index 100% rename from doc/source/deploy_install_guides/current/openstack/uninstall_delete.rst rename to doc/source/deploy_install_guides/r2_release/openstack/uninstall_delete.rst diff --git a/doc/source/deploy_install_guides/current/virtual/aio_duplex.rst b/doc/source/deploy_install_guides/r2_release/virtual/aio_duplex.rst similarity index 100% rename from doc/source/deploy_install_guides/current/virtual/aio_duplex.rst rename to doc/source/deploy_install_guides/r2_release/virtual/aio_duplex.rst diff --git a/doc/source/deploy_install_guides/current/virtual/aio_duplex_environ.rst b/doc/source/deploy_install_guides/r2_release/virtual/aio_duplex_environ.rst similarity index 100% rename from doc/source/deploy_install_guides/current/virtual/aio_duplex_environ.rst rename to doc/source/deploy_install_guides/r2_release/virtual/aio_duplex_environ.rst diff --git a/doc/source/deploy_install_guides/current/virtual/aio_duplex_install_kubernetes.rst b/doc/source/deploy_install_guides/r2_release/virtual/aio_duplex_install_kubernetes.rst similarity index 100% rename from doc/source/deploy_install_guides/current/virtual/aio_duplex_install_kubernetes.rst rename to doc/source/deploy_install_guides/r2_release/virtual/aio_duplex_install_kubernetes.rst diff --git a/doc/source/deploy_install_guides/current/virtual/aio_simplex.rst b/doc/source/deploy_install_guides/r2_release/virtual/aio_simplex.rst similarity index 100% rename from doc/source/deploy_install_guides/current/virtual/aio_simplex.rst rename to doc/source/deploy_install_guides/r2_release/virtual/aio_simplex.rst diff --git a/doc/source/deploy_install_guides/current/virtual/aio_simplex_environ.rst b/doc/source/deploy_install_guides/r2_release/virtual/aio_simplex_environ.rst similarity index 100% rename from doc/source/deploy_install_guides/current/virtual/aio_simplex_environ.rst rename to doc/source/deploy_install_guides/r2_release/virtual/aio_simplex_environ.rst diff --git a/doc/source/deploy_install_guides/current/virtual/aio_simplex_install_kubernetes.rst b/doc/source/deploy_install_guides/r2_release/virtual/aio_simplex_install_kubernetes.rst similarity index 100% rename from doc/source/deploy_install_guides/current/virtual/aio_simplex_install_kubernetes.rst rename to doc/source/deploy_install_guides/r2_release/virtual/aio_simplex_install_kubernetes.rst diff --git a/doc/source/deploy_install_guides/current/virtual/controller_storage.rst b/doc/source/deploy_install_guides/r2_release/virtual/controller_storage.rst similarity index 100% rename from doc/source/deploy_install_guides/current/virtual/controller_storage.rst rename to doc/source/deploy_install_guides/r2_release/virtual/controller_storage.rst diff --git a/doc/source/deploy_install_guides/current/virtual/controller_storage_environ.rst b/doc/source/deploy_install_guides/r2_release/virtual/controller_storage_environ.rst similarity index 100% rename from doc/source/deploy_install_guides/current/virtual/controller_storage_environ.rst rename to doc/source/deploy_install_guides/r2_release/virtual/controller_storage_environ.rst diff --git a/doc/source/deploy_install_guides/current/virtual/controller_storage_install_kubernetes.rst b/doc/source/deploy_install_guides/r2_release/virtual/controller_storage_install_kubernetes.rst similarity index 100% rename from doc/source/deploy_install_guides/current/virtual/controller_storage_install_kubernetes.rst rename to doc/source/deploy_install_guides/r2_release/virtual/controller_storage_install_kubernetes.rst diff --git a/doc/source/deploy_install_guides/current/virtual/dedicated_storage.rst b/doc/source/deploy_install_guides/r2_release/virtual/dedicated_storage.rst similarity index 100% rename from doc/source/deploy_install_guides/current/virtual/dedicated_storage.rst rename to doc/source/deploy_install_guides/r2_release/virtual/dedicated_storage.rst diff --git a/doc/source/deploy_install_guides/current/virtual/dedicated_storage_environ.rst b/doc/source/deploy_install_guides/r2_release/virtual/dedicated_storage_environ.rst similarity index 100% rename from doc/source/deploy_install_guides/current/virtual/dedicated_storage_environ.rst rename to doc/source/deploy_install_guides/r2_release/virtual/dedicated_storage_environ.rst diff --git a/doc/source/deploy_install_guides/current/virtual/dedicated_storage_install_kubernetes.rst b/doc/source/deploy_install_guides/r2_release/virtual/dedicated_storage_install_kubernetes.rst similarity index 100% rename from doc/source/deploy_install_guides/current/virtual/dedicated_storage_install_kubernetes.rst rename to doc/source/deploy_install_guides/r2_release/virtual/dedicated_storage_install_kubernetes.rst diff --git a/doc/source/deploy_install_guides/current/virtual/physical_host_req.txt b/doc/source/deploy_install_guides/r2_release/virtual/physical_host_req.txt similarity index 100% rename from doc/source/deploy_install_guides/current/virtual/physical_host_req.txt rename to doc/source/deploy_install_guides/r2_release/virtual/physical_host_req.txt diff --git a/doc/source/developer_resources/index.rst b/doc/source/developer_resources/index.rst index 8ab146812..7be45c711 100644 --- a/doc/source/developer_resources/index.rst +++ b/doc/source/developer_resources/index.rst @@ -4,13 +4,9 @@ Developer Resources =================== -StarlingX developer resources exist that help you understand the +StarlingX developer resources provide information to help you understand the architecture of the documentation, how to navigate the StarlingX -source code, and understand the development process. - -The developer guide is release-specific. -The following list provides help on choosing the correct -developer guide based on a release: +source code, and to understand the development process. .. toctree:: :maxdepth: 1