diff --git a/doc/source/.vscode/settings.json b/doc/source/.vscode/settings.json deleted file mode 100644 index 274e42384..000000000 --- a/doc/source/.vscode/settings.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "restructuredtext.confPath": "" -} diff --git a/doc/source/_includes/project-networks.rest b/doc/source/_includes/project-networks.rest old mode 100755 new mode 100644 diff --git a/doc/source/_includes/r5_kubernetes_install_next.txt b/doc/source/_includes/r5_kubernetes_install_next.txt index 65944e54e..2f2d8440b 100644 --- a/doc/source/_includes/r5_kubernetes_install_next.txt +++ b/doc/source/_includes/r5_kubernetes_install_next.txt @@ -4,4 +4,4 @@ For instructions on how to access StarlingX Kubernetes see :ref:`kubernetes_access`. For instructions on how to install and access StarlingX OpenStack see -:doc:`/deploy_install_guides/r5_release/openstack/index`. \ No newline at end of file +:doc:`/deploy_install_guides/r5_release/openstack/index-install-r5-os-bf0f49699241`. \ No newline at end of file diff --git a/doc/source/_includes/vm-network-interface-options.rest b/doc/source/_includes/vm-network-interface-options.rest old mode 100755 new mode 100644 diff --git a/doc/source/_vendor/vendor_strings.txt b/doc/source/_vendor/vendor_strings.txt old mode 100755 new mode 100644 diff --git a/doc/source/admintasks/index.rst b/doc/source/admintasks/index-admintasks-768a6e9aaeff.rst similarity index 77% rename from doc/source/admintasks/index.rst rename to doc/source/admintasks/index-admintasks-768a6e9aaeff.rst index ae887e44e..ff267393f 100644 --- a/doc/source/admintasks/index.rst +++ b/doc/source/admintasks/index-admintasks-768a6e9aaeff.rst @@ -1,4 +1,4 @@ -.. _admintasks-index: +.. _index-admintasks-768a6e9aaeff: =========== Admin Tasks @@ -18,7 +18,7 @@ of common administrative tasks. .. toctree:: :maxdepth: 2 - kubernetes/index + kubernetes/index-admintasks-kub-ebc55fefc368 ------------------- StarlingX OpenStack @@ -34,4 +34,4 @@ openstack-compute host basis. .. toctree:: :maxdepth: 2 - openstack/index + openstack/index-admintasks-os-22bdf545d2f2 diff --git a/doc/source/admintasks/kubernetes/index.rst b/doc/source/admintasks/kubernetes/index-admintasks-kub-ebc55fefc368.rst similarity index 92% rename from doc/source/admintasks/kubernetes/index.rst rename to doc/source/admintasks/kubernetes/index-admintasks-kub-ebc55fefc368.rst index 939292cb7..02e2aef56 100644 --- a/doc/source/admintasks/kubernetes/index.rst +++ b/doc/source/admintasks/kubernetes/index-admintasks-kub-ebc55fefc368.rst @@ -1,11 +1,11 @@ -.. _admintasks-kubernetes-index: +.. _index-admintasks-kub-ebc55fefc368: .. include:: /_includes/toc-title-admintasks-kub.rest .. only:: partner - .. include:: /admintasks/index.rst + .. include:: /admintasks/index-admintasks-768a6e9aaeff.rst :start-after: kub-begin :end-before: kub-end diff --git a/doc/source/admintasks/openstack/index.rst b/doc/source/admintasks/openstack/index-admintasks-os-22bdf545d2f2.rst similarity index 62% rename from doc/source/admintasks/openstack/index.rst rename to doc/source/admintasks/openstack/index-admintasks-os-22bdf545d2f2.rst index 4c0a383a6..479bdb097 100644 --- a/doc/source/admintasks/openstack/index.rst +++ b/doc/source/admintasks/openstack/index-admintasks-os-22bdf545d2f2.rst @@ -4,7 +4,7 @@ .. only:: partner - .. include:: /admintasks/index.rst + .. include:: /admintasks/index-admintasks-768a6e9aaeff.rst :start-after: os-begin :end-before: os-end diff --git a/doc/source/backup/index.rst b/doc/source/backup/index-backup-1b466179efc3.rst similarity index 66% rename from doc/source/backup/index.rst rename to doc/source/backup/index-backup-1b466179efc3.rst index 3dfacea93..988fa8cf4 100644 --- a/doc/source/backup/index.rst +++ b/doc/source/backup/index-backup-1b466179efc3.rst @@ -1,3 +1,5 @@ +.. _index-backup-1b466179efc3: + ================== Backup and Restore ================== @@ -11,7 +13,7 @@ Kubernetes .. toctree:: :maxdepth: 2 - kubernetes/index + kubernetes/index-backup-kub-699e0d16c076 --------- OpenStack @@ -22,4 +24,4 @@ OpenStack .. toctree:: :maxdepth: 2 - openstack/index \ No newline at end of file + openstack/index-backup-os-2b4f93282ec4 \ No newline at end of file diff --git a/doc/source/backup/kubernetes/index.rst b/doc/source/backup/kubernetes/index-backup-kub-699e0d16c076.rst similarity index 95% rename from doc/source/backup/kubernetes/index.rst rename to doc/source/backup/kubernetes/index-backup-kub-699e0d16c076.rst index ff9af3874..f09920706 100644 --- a/doc/source/backup/kubernetes/index.rst +++ b/doc/source/backup/kubernetes/index-backup-kub-699e0d16c076.rst @@ -1,3 +1,5 @@ +.. _index-backup-kub-699e0d16c076: + .. Backup and Restore file, created by sphinx-quickstart on Thu Sep 3 15:14:59 2020. You can adapt this file completely to your liking, but it should at least diff --git a/doc/source/backup/openstack/index.rst b/doc/source/backup/openstack/index-backup-os-2b4f93282ec4.rst similarity index 74% rename from doc/source/backup/openstack/index.rst rename to doc/source/backup/openstack/index-backup-os-2b4f93282ec4.rst index 840d3b1b7..491e1d872 100644 --- a/doc/source/backup/openstack/index.rst +++ b/doc/source/backup/openstack/index-backup-os-2b4f93282ec4.rst @@ -1,3 +1,4 @@ +.. _index-backup-os-2b4f93282ec4: .. include:: /_includes/toc-title-backup-kub.rest diff --git a/doc/source/contributor/doc_contribute_guide.rst b/doc/source/contributor/doc_contribute_guide.rst index ac9a6eef0..f62001410 100644 --- a/doc/source/contributor/doc_contribute_guide.rst +++ b/doc/source/contributor/doc_contribute_guide.rst @@ -78,10 +78,10 @@ Docs organization Documentation for StarlingX is organized into the following sections: -:doc:`/introduction/index` +:doc:`/introduction/index-intro-27197f27ad41` Overview of the StarlingX project. -:doc:`/deploy_install_guides/index` +:doc:`/deploy_install_guides/index-install-e083ca818006` Release-specific installation and deployment guides. :doc:`/configuration/index` diff --git a/doc/source/datanet/index.rst b/doc/source/datanet/index-datanet-e316bf6c2f6a.rst similarity index 75% rename from doc/source/datanet/index.rst rename to doc/source/datanet/index-datanet-e316bf6c2f6a.rst index 2f9583ef6..c3c406603 100644 --- a/doc/source/datanet/index.rst +++ b/doc/source/datanet/index-datanet-e316bf6c2f6a.rst @@ -1,6 +1,5 @@ -.. -.. _datanet_index: +.. _index-datanet-e316bf6c2f6a: ============= Data Networks @@ -20,7 +19,7 @@ are attached to node data, pci-sriov and pci-passthrough interfaces. .. toctree:: :maxdepth: 2 - kubernetes/index + kubernetes/index-datanet-kub-500ef820efd8 --------- @@ -37,4 +36,4 @@ and pci-passthrough interfaces attach to. .. toctree:: :maxdepth: 2 - openstack/index + openstack/index-datanet-os-aff0f5fbfb86 diff --git a/doc/source/datanet/kubernetes/index.rst b/doc/source/datanet/kubernetes/index-datanet-kub-500ef820efd8.rst similarity index 88% rename from doc/source/datanet/kubernetes/index.rst rename to doc/source/datanet/kubernetes/index-datanet-kub-500ef820efd8.rst index e82800e86..866e8c8ac 100644 --- a/doc/source/datanet/kubernetes/index.rst +++ b/doc/source/datanet/kubernetes/index-datanet-kub-500ef820efd8.rst @@ -1,12 +1,11 @@ -.. -.. _datanet_kubernetes_index: +.. _index-datanet-kub-500ef820efd8: .. include:: /_includes/toc-title-datanet-kub.rest .. only:: partner - .. include:: /datanet/index.rst + .. include:: /datanet/index-datanet-e316bf6c2f6a.rst :start-after: kub-begin :end-before: kub-end diff --git a/doc/source/datanet/openstack/index.rst b/doc/source/datanet/openstack/index-datanet-os-aff0f5fbfb86.rst similarity index 90% rename from doc/source/datanet/openstack/index.rst rename to doc/source/datanet/openstack/index-datanet-os-aff0f5fbfb86.rst index 766ea2b8b..9c3e76682 100644 --- a/doc/source/datanet/openstack/index.rst +++ b/doc/source/datanet/openstack/index-datanet-os-aff0f5fbfb86.rst @@ -1,13 +1,7 @@ -.. _datanet_openstack_index: +.. _index-datanet-os-aff0f5fbfb86: .. include:: /_includes/toc-title-datanet-os.rest -.. only:: partner - - .. include:: /datanet/index.rst - :start-after: os-begin - :end-before: os-end - .. toctree:: :maxdepth: 1 diff --git a/doc/source/deploy/index.rst b/doc/source/deploy/index-deploy-da06a98b83b1.rst similarity index 92% rename from doc/source/deploy/index.rst rename to doc/source/deploy/index-deploy-da06a98b83b1.rst index b0a66d09f..878da9742 100644 --- a/doc/source/deploy/index.rst +++ b/doc/source/deploy/index-deploy-da06a98b83b1.rst @@ -1,4 +1,4 @@ -.. _deployment-index: +.. _index-deploy-da06a98b83b1: ========================= Deployment Configurations @@ -30,4 +30,4 @@ A variety of |prod-long| deployment configuration options are supported. .. toctree:: :maxdepth: 2 - kubernetes/index \ No newline at end of file + kubernetes/index-deploy-kub-844a2a88f529 \ No newline at end of file diff --git a/doc/source/deploy/kubernetes/index.rst b/doc/source/deploy/kubernetes/index-deploy-kub-844a2a88f529.rst similarity index 87% rename from doc/source/deploy/kubernetes/index.rst rename to doc/source/deploy/kubernetes/index-deploy-kub-844a2a88f529.rst index fe99f05d0..0bc74d869 100644 --- a/doc/source/deploy/kubernetes/index.rst +++ b/doc/source/deploy/kubernetes/index-deploy-kub-844a2a88f529.rst @@ -1,4 +1,4 @@ -.. _deploy-kubernetes-index: +.. _index-deploy-kub-844a2a88f529: .. only:: starlingx @@ -7,7 +7,7 @@ .. only:: partner - .. include:: /deploy/index.rst + .. include:: /deploy/index-deploy-da06a98b83b1.rst :start-after: kub-begin :end-before: kub-end diff --git a/doc/source/deploy_install_guides/index.rst b/doc/source/deploy_install_guides/index-install-e083ca818006.rst old mode 100755 new mode 100644 similarity index 91% rename from doc/source/deploy_install_guides/index.rst rename to doc/source/deploy_install_guides/index-install-e083ca818006.rst index 0ec76aca6..3631506be --- a/doc/source/deploy_install_guides/index.rst +++ b/doc/source/deploy_install_guides/index-install-e083ca818006.rst @@ -1,3 +1,5 @@ +.. _index-install-e083ca818006: + =================== Installation Guides =================== @@ -17,7 +19,7 @@ StarlingX R5.0 is the most recent supported release of StarlingX. .. toctree:: :maxdepth: 1 - r5_release/index + r5_release/index-install-r5-ca4053cb3ab9 diff --git a/doc/source/deploy_install_guides/r1_release/index.rst b/doc/source/deploy_install_guides/r1_release/index.rst index f712ae237..7cac01da9 100644 --- a/doc/source/deploy_install_guides/r1_release/index.rst +++ b/doc/source/deploy_install_guides/r1_release/index.rst @@ -11,8 +11,7 @@ StarlingX R1.0 Installation Installation of the current :ref:`latest_release` is recommended. This is the installation guide for the StarlingX R1.0 release. If this is not -the installation guide you want to use, see the :doc:`available installation -guides `. +the installation guide you want to use, see the :ref:`index-install-e083ca818006`. ------------ Introduction diff --git a/doc/source/deploy_install_guides/r3_release/figures/starlingx-aio-controller-configuration.png b/doc/source/deploy_install_guides/r3_release/figures/starlingx-aio-controller-configuration.png old mode 100755 new mode 100644 diff --git a/doc/source/deploy_install_guides/r3_release/figures/starlingx-aio-serial-console.png b/doc/source/deploy_install_guides/r3_release/figures/starlingx-aio-serial-console.png old mode 100755 new mode 100644 diff --git a/doc/source/deploy_install_guides/r3_release/figures/starlingx-release3-ansible-bootstrap-simplex.png b/doc/source/deploy_install_guides/r3_release/figures/starlingx-release3-ansible-bootstrap-simplex.png old mode 100755 new mode 100644 diff --git a/doc/source/deploy_install_guides/r4_release/virtual/install_virtualbox.rst b/doc/source/deploy_install_guides/r4_release/virtual/install_virtualbox.rst index f2cc17265..a2f7bc901 100644 --- a/doc/source/deploy_install_guides/r4_release/virtual/install_virtualbox.rst +++ b/doc/source/deploy_install_guides/r4_release/virtual/install_virtualbox.rst @@ -278,8 +278,7 @@ Console usage: For details on how to specify installation parameters such as rootfs device and console port, see :ref:`config_install_parms`. -Follow the :doc:`StarlingX Installation and Deployment Guides ` -to continue. +Follow the :ref:`index-install-e083ca818006` instructions to continue. * Ensure that boot priority on all VMs is changed using the commands in the "Set the boot priority" step above. diff --git a/doc/source/deploy_install_guides/r5_release/distributed_cloud/index.rst b/doc/source/deploy_install_guides/r5_release/distributed_cloud/index-install-r5-distcloud-8164d5952ac5.rst similarity index 99% rename from doc/source/deploy_install_guides/r5_release/distributed_cloud/index.rst rename to doc/source/deploy_install_guides/r5_release/distributed_cloud/index-install-r5-distcloud-8164d5952ac5.rst index 42974c011..f77db806d 100644 --- a/doc/source/deploy_install_guides/r5_release/distributed_cloud/index.rst +++ b/doc/source/deploy_install_guides/r5_release/distributed_cloud/index-install-r5-distcloud-8164d5952ac5.rst @@ -1,3 +1,5 @@ +.. _index-install-r5-distcloud-8164d5952ac5: + =================================== Distributed Cloud Installation R5.0 =================================== diff --git a/doc/source/deploy_install_guides/r5_release/index.rst b/doc/source/deploy_install_guides/r5_release/index-install-r5-ca4053cb3ab9.rst similarity index 87% rename from doc/source/deploy_install_guides/r5_release/index.rst rename to doc/source/deploy_install_guides/r5_release/index-install-r5-ca4053cb3ab9.rst index 8cefaf22e..5e40cbb3a 100644 --- a/doc/source/deploy_install_guides/r5_release/index.rst +++ b/doc/source/deploy_install_guides/r5_release/index-install-r5-ca4053cb3ab9.rst @@ -1,10 +1,13 @@ +.. _index-install-r5-ca4053cb3ab9: + =========================== StarlingX R5.0 Installation =========================== StarlingX provides a pre-defined set of standard -:doc:`deployment configurations `. Most deployment options may -be installed in a virtual environment or on bare metal. +:doc:`deployment configurations `. +Most deployment options may be installed in a virtual +environment or on bare metal. ----------------------------------------------------- Install StarlingX Kubernetes in a virtual environment @@ -114,7 +117,7 @@ Install StarlingX Distributed Cloud on bare metal .. toctree:: :maxdepth: 1 - distributed_cloud/index + distributed_cloud/index-install-r5-distcloud-8164d5952ac5 ----------------- Access Kubernetes @@ -132,5 +135,5 @@ Access StarlingX OpenStack .. toctree:: :maxdepth: 1 - openstack/index + openstack/index-install-r5-os-bf0f49699241 diff --git a/doc/source/deploy_install_guides/r5_release/openstack/index.rst b/doc/source/deploy_install_guides/r5_release/openstack/index-install-r5-os-bf0f49699241.rst similarity index 86% rename from doc/source/deploy_install_guides/r5_release/openstack/index.rst rename to doc/source/deploy_install_guides/r5_release/openstack/index-install-r5-os-bf0f49699241.rst index 9b429da9d..1df5c41d6 100644 --- a/doc/source/deploy_install_guides/r5_release/openstack/index.rst +++ b/doc/source/deploy_install_guides/r5_release/openstack/index-install-r5-os-bf0f49699241.rst @@ -1,3 +1,5 @@ +.. _index-install-r5-os-bf0f49699241: + =================== StarlingX OpenStack =================== diff --git a/doc/source/deploy_install_guides/r5_release/virtual/install_virtualbox.rst b/doc/source/deploy_install_guides/r5_release/virtual/install_virtualbox.rst index 2d099a3df..aa1c6ab97 100644 --- a/doc/source/deploy_install_guides/r5_release/virtual/install_virtualbox.rst +++ b/doc/source/deploy_install_guides/r5_release/virtual/install_virtualbox.rst @@ -278,7 +278,7 @@ Console usage: For details on how to specify installation parameters such as rootfs device and console port, see :ref:`config_install_parms`. -Follow the :doc:`StarlingX Installation and Deployment Guides ` +Follow the :ref:`index-install-e083ca818006` to continue. * Ensure that boot priority on all VMs is changed using the commands in the "Set diff --git a/doc/source/dist_cloud/index.rst b/doc/source/dist_cloud/index-dist-cloud-f5dbeb16b976.rst similarity index 78% rename from doc/source/dist_cloud/index.rst rename to doc/source/dist_cloud/index-dist-cloud-f5dbeb16b976.rst index 959186468..335a70e7a 100644 --- a/doc/source/dist_cloud/index.rst +++ b/doc/source/dist_cloud/index-dist-cloud-f5dbeb16b976.rst @@ -1,5 +1,5 @@ -.. _dist-cloud-index: +.. _index-dist-cloud-f5dbeb16b976: ================= Distributed Cloud @@ -16,5 +16,5 @@ distributed network of |prod| systems. .. toctree:: :maxdepth: 2 - kubernetes/index + kubernetes/index-dist-cloud-kub-95bef233eef0 diff --git a/doc/source/dist_cloud/kubernetes/index.rst b/doc/source/dist_cloud/kubernetes/index-dist-cloud-kub-95bef233eef0.rst similarity index 97% rename from doc/source/dist_cloud/kubernetes/index.rst rename to doc/source/dist_cloud/kubernetes/index-dist-cloud-kub-95bef233eef0.rst index 535d10075..768e7adb7 100644 --- a/doc/source/dist_cloud/kubernetes/index.rst +++ b/doc/source/dist_cloud/kubernetes/index-dist-cloud-kub-95bef233eef0.rst @@ -1,11 +1,11 @@ -.. _dist-cloud-kubernetes-index: +.. _index-dist-cloud-kub-95bef233eef0: .. include:: /_includes/toc-title-dc-kub.rest .. only:: partner - .. include:: /dist_cloud/index.rst + .. include:: /dist_cloud/index-dist-cloud-f5dbeb16b976.rst :start-after: kub-begin :end-before: kub-end diff --git a/doc/source/fault-mgmt/index.rst b/doc/source/fault-mgmt/index-fault-98d5f50a9b8c.rst similarity index 86% rename from doc/source/fault-mgmt/index.rst rename to doc/source/fault-mgmt/index-fault-98d5f50a9b8c.rst index acc3cab7b..85013f3d7 100644 --- a/doc/source/fault-mgmt/index.rst +++ b/doc/source/fault-mgmt/index-fault-98d5f50a9b8c.rst @@ -3,6 +3,8 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. +.. _index-fault-98d5f50a9b8c: + ================ Fault Management ================ @@ -18,7 +20,7 @@ StarlingX Kubernetes .. toctree:: :maxdepth: 2 - kubernetes/index + kubernetes/index-fault-kub-f45ef76b6f16 ------------------- StarlingX OpenStack @@ -37,4 +39,4 @@ that are monitored and reported for the |prod-os| application through the .. toctree:: :maxdepth: 2 - openstack/index + openstack/index-fault-os-a1a5cae095b3 diff --git a/doc/source/fault-mgmt/kubernetes/index.rst b/doc/source/fault-mgmt/kubernetes/index-fault-kub-f45ef76b6f16.rst similarity index 95% rename from doc/source/fault-mgmt/kubernetes/index.rst rename to doc/source/fault-mgmt/kubernetes/index-fault-kub-f45ef76b6f16.rst index 4142cc373..bfd960ebc 100644 --- a/doc/source/fault-mgmt/kubernetes/index.rst +++ b/doc/source/fault-mgmt/kubernetes/index-fault-kub-f45ef76b6f16.rst @@ -1,10 +1,10 @@ -.. _fault-mgmt-kubernetes-index: +.. _index-fault-kub-f45ef76b6f16: .. include:: /_includes/toc-title-fm-kub.rest .. only:: partner - .. include:: /fault-mgmt/index.rst + .. include:: /fault-mgmt/index-fault-98d5f50a9b8c.rst :start-after: kub-begin :end-before: kub-end diff --git a/doc/source/fault-mgmt/openstack/index.rst b/doc/source/fault-mgmt/openstack/index-fault-os-a1a5cae095b3.rst similarity index 74% rename from doc/source/fault-mgmt/openstack/index.rst rename to doc/source/fault-mgmt/openstack/index-fault-os-a1a5cae095b3.rst index a02caecfe..c010c6c80 100644 --- a/doc/source/fault-mgmt/openstack/index.rst +++ b/doc/source/fault-mgmt/openstack/index-fault-os-a1a5cae095b3.rst @@ -1,12 +1,7 @@ -.. _fault-mgmt-openstack-index: +.. _index-fault-os-a1a5cae095b3: .. include:: /_includes/toc-title-fm-os.rest -.. only:: partner - - .. include:: /fault-mgmt/index.rst - :start-after: os-begin - :end-before: os-end .. toctree:: :maxdepth: 1 @@ -34,4 +29,4 @@ OpenStack customer log messages openstack-customer-log-messages-270s-virtual-machines openstack-customer-log-messages-401s-services - openstack-customer-log-messages-700s-virtual-machines \ No newline at end of file + openstack-customer-log-messages-700s-virtual-machines diff --git a/doc/source/guest_integration/index.rst b/doc/source/guest_integration/index-guest-ef8c9a20bf6c.rst similarity index 85% rename from doc/source/guest_integration/index.rst rename to doc/source/guest_integration/index-guest-ef8c9a20bf6c.rst index 0ed3ed3e7..f95953b96 100644 --- a/doc/source/guest_integration/index.rst +++ b/doc/source/guest_integration/index-guest-ef8c9a20bf6c.rst @@ -1,5 +1,5 @@ -.. _guest-integration-index: +.. _index-guest-ef8c9a20bf6c: ================= @@ -21,7 +21,7 @@ applications are able to receive |PTP| status notifications from .. toctree:: :maxdepth: 2 - kubernetes/index + kubernetes/index-guest-kub-5c89ec07e141 ------------------------- OpenStack VNF integration @@ -38,4 +38,4 @@ application on |prod-os|. .. toctree:: :maxdepth: 2 - openstack/index + openstack/index-guest-os-17b56b5745b6 diff --git a/doc/source/guest_integration/kubernetes/index.rst b/doc/source/guest_integration/kubernetes/index-guest-kub-5c89ec07e141.rst similarity index 80% rename from doc/source/guest_integration/kubernetes/index.rst rename to doc/source/guest_integration/kubernetes/index-guest-kub-5c89ec07e141.rst index f8644788c..97c0d0459 100644 --- a/doc/source/guest_integration/kubernetes/index.rst +++ b/doc/source/guest_integration/kubernetes/index-guest-kub-5c89ec07e141.rst @@ -1,10 +1,10 @@ -.. _guest-kubernetes-index: +.. _index-guest-kub-5c89ec07e141: .. include:: /_includes/toc-title-guest-kub.rest .. only:: partner - .. include:: /guest_integration/index.rst + .. include:: /guest_integration/index-guest-ef8c9a20bf6c.rst :start-after: kub-begin :end-before: kub-end diff --git a/doc/source/guest_integration/openstack/index.rst b/doc/source/guest_integration/openstack/index-guest-os-17b56b5745b6.rst similarity index 88% rename from doc/source/guest_integration/openstack/index.rst rename to doc/source/guest_integration/openstack/index-guest-os-17b56b5745b6.rst index 6fce42242..07691f32e 100644 --- a/doc/source/guest_integration/openstack/index.rst +++ b/doc/source/guest_integration/openstack/index-guest-os-17b56b5745b6.rst @@ -1,10 +1,10 @@ -.. _guest-openstack-index: +.. _index-guest-os-17b56b5745b6: .. include:: /_includes/toc-title-guest-os.rest .. only:: partner - .. include:: /guest_integration/index.rst + .. include:: /guest_integration/index-guest-ef8c9a20bf6c.rst :start-after: os-begin :end-before: os-end diff --git a/doc/source/index.rst b/doc/source/index.rst old mode 100755 new mode 100644 index ec210e989..73a0dd4a4 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -37,7 +37,7 @@ Learn more about StarlingX: .. toctree:: :maxdepth: 2 - introduction/index + introduction/index-intro-27197f27ad41 ------------------------- Deployment configurations @@ -46,7 +46,7 @@ Deployment configurations .. toctree:: :maxdepth: 2 - deploy/index + deploy/index-deploy-da06a98b83b1 -------- Planning @@ -55,7 +55,7 @@ Planning .. toctree:: :maxdepth: 2 - planning/index + planning/index-planning-332af0718d15 ------------------- Installation guides @@ -64,7 +64,7 @@ Installation guides .. toctree:: :maxdepth: 2 - deploy_install_guides/index + deploy_install_guides/index-install-e083ca818006 -------- Security @@ -73,7 +73,7 @@ Security .. toctree:: :maxdepth: 2 - security/index + security/index-security-84d0d8aa401b -------------------- @@ -83,7 +83,7 @@ System configuration .. toctree:: :maxdepth: 2 - system_configuration/index + system_configuration/index-sysconf-d511820651f0 ------------- @@ -93,7 +93,7 @@ Data networks .. toctree:: :maxdepth: 2 - datanet/index + datanet/index-datanet-e316bf6c2f6a --------------- Node management @@ -102,7 +102,7 @@ Node management .. toctree:: :maxdepth: 2 - node_management/index + node_management/index-node-mgmt-cd0f9d8eaee6 ------- Storage @@ -111,7 +111,7 @@ Storage .. toctree:: :maxdepth: 2 - storage/index + storage/index-storage-6cd708f1ada9 ---------------- @@ -121,7 +121,7 @@ Fault management .. toctree:: :maxdepth: 2 - fault-mgmt/index + fault-mgmt/index-fault-98d5f50a9b8c ------------------ @@ -131,7 +131,7 @@ Backup and restore .. toctree:: :maxdepth: 2 - backup/index + backup/index-backup-1b466179efc3 ------- @@ -141,7 +141,7 @@ Updates .. toctree:: :maxdepth: 2 - updates/index + updates/index-updates-e3b970bb69ce ----------- @@ -151,7 +151,7 @@ Admin tasks .. toctree:: :maxdepth: 2 - admintasks/index + admintasks/index-admintasks-768a6e9aaeff ---------- @@ -161,7 +161,7 @@ User tasks .. toctree:: :maxdepth: 2 - usertasks/index + usertasks/index-usertasks-b18b379ab832 ----------------- @@ -171,7 +171,7 @@ Guest integration .. toctree:: :maxdepth: 2 - guest_integration/index + guest_integration/index-guest-ef8c9a20bf6c --------- @@ -191,7 +191,7 @@ Distributed Cloud .. toctree:: :maxdepth: 2 - dist_cloud/index + dist_cloud/index-dist-cloud-f5dbeb16b976 ----------------- Deprecated guides diff --git a/doc/source/introduction/index.rst b/doc/source/introduction/index-intro-27197f27ad41.rst similarity index 93% rename from doc/source/introduction/index.rst rename to doc/source/introduction/index-intro-27197f27ad41.rst index e6ac6a6d1..a8cb667be 100644 --- a/doc/source/introduction/index.rst +++ b/doc/source/introduction/index-intro-27197f27ad41.rst @@ -1,3 +1,5 @@ +.. _index-intro-27197f27ad41: + ============ Introduction ============ diff --git a/doc/source/node_management/index.rst b/doc/source/node_management/index-node-mgmt-cd0f9d8eaee6.rst similarity index 92% rename from doc/source/node_management/index.rst rename to doc/source/node_management/index-node-mgmt-cd0f9d8eaee6.rst index 808310a7a..88a60a3b9 100644 --- a/doc/source/node_management/index.rst +++ b/doc/source/node_management/index-node-mgmt-cd0f9d8eaee6.rst @@ -1,3 +1,5 @@ +.. _index-node-mgmt-cd0f9d8eaee6: + =============== Node Management =============== @@ -40,7 +42,7 @@ Complete instructions for adding a worker node are provided in the .. toctree:: :maxdepth: 2 - kubernetes/index + kubernetes/index-node-mgmt-kub-5ff5993b9c60 --------- OpenStack @@ -62,4 +64,4 @@ Add an OpenStack compute node .. toctree:: :maxdepth: 2 - openstack/index + openstack/index-node-mgmt-os-ccb47338adbc diff --git a/doc/source/node_management/kubernetes/index.rst b/doc/source/node_management/kubernetes/index-node-mgmt-kub-5ff5993b9c60.rst similarity index 98% rename from doc/source/node_management/kubernetes/index.rst rename to doc/source/node_management/kubernetes/index-node-mgmt-kub-5ff5993b9c60.rst index b8cd3a5e6..8d4430d39 100644 --- a/doc/source/node_management/kubernetes/index.rst +++ b/doc/source/node_management/kubernetes/index-node-mgmt-kub-5ff5993b9c60.rst @@ -1,11 +1,11 @@ -.. _node-mgmt-kubernetes-index: +.. _index-node-mgmt-kub-5ff5993b9c60: .. include:: /_includes/toc-title-node-kub.rest .. only:: partner - .. include:: /node_management/index.rst + .. include:: /node_management/index-node-mgmt-cd0f9d8eaee6.rst :start-after: kub-begin :end-before: kub-end diff --git a/doc/source/node_management/openstack/index.rst b/doc/source/node_management/openstack/index-node-mgmt-os-ccb47338adbc.rst similarity index 88% rename from doc/source/node_management/openstack/index.rst rename to doc/source/node_management/openstack/index-node-mgmt-os-ccb47338adbc.rst index e5f250ae5..98b8aaaec 100644 --- a/doc/source/node_management/openstack/index.rst +++ b/doc/source/node_management/openstack/index-node-mgmt-os-ccb47338adbc.rst @@ -1,11 +1,11 @@ -.. _node-mgmt-openstack-index: +.. _index-node-mgmt-os-ccb47338adbc: .. include:: /_includes/toc-title-node-os.rest .. only:: partner - .. include:: /node_management/index.rst + .. include:: /node_management/index-node-mgmt-cd0f9d8eaee6.rst :start-after: os-begin :end-before: os-end diff --git a/doc/source/operations/tsn.rst b/doc/source/operations/tsn.rst index 713359709..c328530e8 100644 --- a/doc/source/operations/tsn.rst +++ b/doc/source/operations/tsn.rst @@ -111,8 +111,8 @@ Edge cloud platform ******************* #. Install STX environment: follow the instructions from the - :doc:`Installation Guides ` to install one - STX environment (for example STX AIO). + :ref:`index-install-e083ca818006` to install one STX environment (for + example STX AIO). #. Prepare a :abbr:`VM (Virtual Machine)` image. Create image ``tsn_ubuntu_19_04.img`` based on Ubuntu 19.04 with the required binaries shown below. diff --git a/doc/source/planning/.vscode/settings.json b/doc/source/planning/.vscode/settings.json old mode 100755 new mode 100644 diff --git a/doc/source/planning/figures/eag1565612501060.png b/doc/source/planning/figures/eag1565612501060.png old mode 100755 new mode 100644 diff --git a/doc/source/planning/figures/fqq1554387160841.png b/doc/source/planning/figures/fqq1554387160841.png old mode 100755 new mode 100644 diff --git a/doc/source/planning/figures/gnc1565626763250.jpeg b/doc/source/planning/figures/gnc1565626763250.jpeg old mode 100755 new mode 100644 diff --git a/doc/source/planning/figures/jow1404333560781.png b/doc/source/planning/figures/jow1404333560781.png old mode 100755 new mode 100644 diff --git a/doc/source/planning/figures/jrh1581365123827.png b/doc/source/planning/figures/jrh1581365123827.png old mode 100755 new mode 100644 diff --git a/doc/source/planning/figures/noc1581364555316.png b/doc/source/planning/figures/noc1581364555316.png old mode 100755 new mode 100644 diff --git a/doc/source/planning/figures/rld1581365711865.png b/doc/source/planning/figures/rld1581365711865.png old mode 100755 new mode 100644 diff --git a/doc/source/planning/figures/rsn1565611176484.png b/doc/source/planning/figures/rsn1565611176484.png old mode 100755 new mode 100644 diff --git a/doc/source/planning/figures/sye1565216249447.png b/doc/source/planning/figures/sye1565216249447.png old mode 100755 new mode 100644 diff --git a/doc/source/planning/figures/uac1581365928043.png b/doc/source/planning/figures/uac1581365928043.png old mode 100755 new mode 100644 diff --git a/doc/source/planning/figures/vzz1565620523528.png b/doc/source/planning/figures/vzz1565620523528.png old mode 100755 new mode 100644 diff --git a/doc/source/planning/figures/xjf1565612136985.png b/doc/source/planning/figures/xjf1565612136985.png old mode 100755 new mode 100644 diff --git a/doc/source/planning/figures/zpk1486667625575.png b/doc/source/planning/figures/zpk1486667625575.png old mode 100755 new mode 100644 diff --git a/doc/source/planning/index.rst b/doc/source/planning/index-planning-332af0718d15.rst old mode 100755 new mode 100644 similarity index 84% rename from doc/source/planning/index.rst rename to doc/source/planning/index-planning-332af0718d15.rst index 1034b2657..d036a071f --- a/doc/source/planning/index.rst +++ b/doc/source/planning/index-planning-332af0718d15.rst @@ -1,3 +1,5 @@ +.. _index-planning-332af0718d15: + .. Planning file, created by sphinx-quickstart on Thu Sep 3 15:14:59 2020. You can adapt this file completely to your liking, but it should at least @@ -26,7 +28,7 @@ installation planning. .. toctree:: :maxdepth: 2 - kubernetes/index + kubernetes/index-planning-kub-913bd621ac0f --------- OpenStack @@ -42,4 +44,4 @@ requires additional network, storage, security and resource planning. .. toctree:: :maxdepth: 2 - openstack/index + openstack/index-planning-os-e815f964d279 diff --git a/doc/source/planning/kubernetes/about-ethernet-interfaces.rst b/doc/source/planning/kubernetes/about-ethernet-interfaces.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/kubernetes/about-the-oam-network.rst b/doc/source/planning/kubernetes/about-the-oam-network.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/kubernetes/controller-disk-configurations-for-all-in-one-systems.rst b/doc/source/planning/kubernetes/controller-disk-configurations-for-all-in-one-systems.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/kubernetes/dns-and-ntp-servers.rst b/doc/source/planning/kubernetes/dns-and-ntp-servers.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/kubernetes/external-netapp-trident-storage.rst b/doc/source/planning/kubernetes/external-netapp-trident-storage.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/kubernetes/hard-drive-options.rst b/doc/source/planning/kubernetes/hard-drive-options.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/kubernetes/index.rst b/doc/source/planning/kubernetes/index-planning-kub-913bd621ac0f.rst old mode 100755 new mode 100644 similarity index 91% rename from doc/source/planning/kubernetes/index.rst rename to doc/source/planning/kubernetes/index-planning-kub-913bd621ac0f.rst index f8b4a2b67..8ef2be097 --- a/doc/source/planning/kubernetes/index.rst +++ b/doc/source/planning/kubernetes/index-planning-kub-913bd621ac0f.rst @@ -1,10 +1,10 @@ -.. _planning_kubernetes_index: +.. _index-planning-kub-913bd621ac0f: .. include:: /_includes/toc-title-planning-kub.rest .. only:: partner - .. include:: /planning/index.rst + .. include:: /planning/index-planning-332af0718d15.rst :start-after: kub-begin :end-before: kub-end diff --git a/doc/source/planning/kubernetes/installation-and-resource-planning-https-access-planning.rst b/doc/source/planning/kubernetes/installation-and-resource-planning-https-access-planning.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/kubernetes/internal-management-network-planning.rst b/doc/source/planning/kubernetes/internal-management-network-planning.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/kubernetes/l2-access-switches.rst b/doc/source/planning/kubernetes/l2-access-switches.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/kubernetes/multicast-subnets-for-the-management-network.rst b/doc/source/planning/kubernetes/multicast-subnets-for-the-management-network.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/kubernetes/network-planning-ethernet-interface-configuration.rst b/doc/source/planning/kubernetes/network-planning-ethernet-interface-configuration.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/kubernetes/network-planning-firewall-options.rst b/doc/source/planning/kubernetes/network-planning-firewall-options.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/kubernetes/network-planning-the-pxe-boot-network.rst b/doc/source/planning/kubernetes/network-planning-the-pxe-boot-network.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/kubernetes/network-requirements-ip-support.rst b/doc/source/planning/kubernetes/network-requirements-ip-support.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/kubernetes/network-requirements.rst b/doc/source/planning/kubernetes/network-requirements.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/kubernetes/networks-for-a-duplex-system.rst b/doc/source/planning/kubernetes/networks-for-a-duplex-system.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/kubernetes/networks-for-a-simplex-system.rst b/doc/source/planning/kubernetes/networks-for-a-simplex-system.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/kubernetes/networks-for-a-system-with-controller-storage.rst b/doc/source/planning/kubernetes/networks-for-a-system-with-controller-storage.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/kubernetes/networks-for-a-system-with-dedicated-storage.rst b/doc/source/planning/kubernetes/networks-for-a-system-with-dedicated-storage.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/kubernetes/oam-network-planning.rst b/doc/source/planning/kubernetes/oam-network-planning.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/kubernetes/overview-of-starlingx-planning.rst b/doc/source/planning/kubernetes/overview-of-starlingx-planning.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/kubernetes/redundant-top-of-rack-switch-deployment-considerations.rst b/doc/source/planning/kubernetes/redundant-top-of-rack-switch-deployment-considerations.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/kubernetes/security-planning-uefi-secure-boot-planning.rst b/doc/source/planning/kubernetes/security-planning-uefi-secure-boot-planning.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/kubernetes/shared-vlan-or-multi-netted-ethernet-interfaces.rst b/doc/source/planning/kubernetes/shared-vlan-or-multi-netted-ethernet-interfaces.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/kubernetes/starlingx-boot-sequence-considerations.rst b/doc/source/planning/kubernetes/starlingx-boot-sequence-considerations.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/kubernetes/starlingx-hardware-requirements.rst b/doc/source/planning/kubernetes/starlingx-hardware-requirements.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/kubernetes/storage-planning-storage-on-controller-hosts.rst b/doc/source/planning/kubernetes/storage-planning-storage-on-controller-hosts.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/kubernetes/storage-planning-storage-on-storage-hosts.rst b/doc/source/planning/kubernetes/storage-planning-storage-on-storage-hosts.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/kubernetes/storage-planning-storage-on-worker-hosts.rst b/doc/source/planning/kubernetes/storage-planning-storage-on-worker-hosts.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/kubernetes/storage-planning-storage-resources.rst b/doc/source/planning/kubernetes/storage-planning-storage-resources.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/kubernetes/the-cluster-host-network.rst b/doc/source/planning/kubernetes/the-cluster-host-network.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/kubernetes/the-ethernet-mtu.rst b/doc/source/planning/kubernetes/the-ethernet-mtu.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/kubernetes/the-internal-management-network.rst b/doc/source/planning/kubernetes/the-internal-management-network.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/kubernetes/the-storage-network.rst b/doc/source/planning/kubernetes/the-storage-network.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/kubernetes/tpm-planning.rst b/doc/source/planning/kubernetes/tpm-planning.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/kubernetes/verified-commercial-hardware.rst b/doc/source/planning/kubernetes/verified-commercial-hardware.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/openstack/block-storage-for-virtual-machines.rst b/doc/source/planning/openstack/block-storage-for-virtual-machines.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/openstack/data-network-planning.rst b/doc/source/planning/openstack/data-network-planning.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/openstack/ethernet-interface-configuration.rst b/doc/source/planning/openstack/ethernet-interface-configuration.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/openstack/ethernet-interfaces.rst b/doc/source/planning/openstack/ethernet-interfaces.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/openstack/hardware-requirements.rst b/doc/source/planning/openstack/hardware-requirements.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/openstack/https-access-planning.rst b/doc/source/planning/openstack/https-access-planning.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/openstack/index.rst b/doc/source/planning/openstack/index-planning-os-e815f964d279.rst old mode 100755 new mode 100644 similarity index 90% rename from doc/source/planning/openstack/index.rst rename to doc/source/planning/openstack/index-planning-os-e815f964d279.rst index 0500a30b1..43519291c --- a/doc/source/planning/openstack/index.rst +++ b/doc/source/planning/openstack/index-planning-os-e815f964d279.rst @@ -1,11 +1,11 @@ -.. _planning-openstack-index: +.. _index-planning-os-e815f964d279: .. include:: /_includes/toc-title-planning-os.rest .. only:: partner - .. include:: /planning/index.rst + .. include:: /planning/index-planning-332af0718d15.rst :start-after: os-begin :end-before: os-end diff --git a/doc/source/planning/openstack/installation-and-resource-planning-controller-disk-configurations-for-all-in-one-systems.rst b/doc/source/planning/openstack/installation-and-resource-planning-controller-disk-configurations-for-all-in-one-systems.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/openstack/installation-and-resource-planning-verified-commercial-hardware.rst b/doc/source/planning/openstack/installation-and-resource-planning-verified-commercial-hardware.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/openstack/internal-dns-resolution.rst b/doc/source/planning/openstack/internal-dns-resolution.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/openstack/network-planning-data-networks.rst b/doc/source/planning/openstack/network-planning-data-networks.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/openstack/network-planning-ip-support.rst b/doc/source/planning/openstack/network-planning-ip-support.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/openstack/network-planning-l2-access-switches.rst b/doc/source/planning/openstack/network-planning-l2-access-switches.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/openstack/network-planning-shared-vlan-or-multi-netted-ethernet-interfaces.rst b/doc/source/planning/openstack/network-planning-shared-vlan-or-multi-netted-ethernet-interfaces.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/openstack/network-planning-the-cluster-host-network.rst b/doc/source/planning/openstack/network-planning-the-cluster-host-network.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/openstack/network-planning-the-internal-management-network.rst b/doc/source/planning/openstack/network-planning-the-internal-management-network.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/openstack/os-data-networks-overview.rst b/doc/source/planning/openstack/os-data-networks-overview.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/openstack/pci-passthrough-ethernet-interfaces.rst b/doc/source/planning/openstack/pci-passthrough-ethernet-interfaces.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/openstack/physical-network-planning.rst b/doc/source/planning/openstack/physical-network-planning.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/openstack/port-security-extension.rst b/doc/source/planning/openstack/port-security-extension.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/openstack/project-network-ip-address-management.rst b/doc/source/planning/openstack/project-network-ip-address-management.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/openstack/project-network-planning.rst b/doc/source/planning/openstack/project-network-planning.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/openstack/project-networks.rst b/doc/source/planning/openstack/project-networks.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/openstack/sr-iov-ethernet-interfaces.rst b/doc/source/planning/openstack/sr-iov-ethernet-interfaces.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/openstack/storage-configuration-storage-on-hosts.rst b/doc/source/planning/openstack/storage-configuration-storage-on-hosts.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/openstack/storage-resources.rst b/doc/source/planning/openstack/storage-resources.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/openstack/subnet-details.rst b/doc/source/planning/openstack/subnet-details.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/openstack/the-ethernet-mtu.rst b/doc/source/planning/openstack/the-ethernet-mtu.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/openstack/the-oam-network.rst b/doc/source/planning/openstack/the-oam-network.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/openstack/the-pxe-boot-network.rst b/doc/source/planning/openstack/the-pxe-boot-network.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/openstack/uefi-secure-boot-planning.rst b/doc/source/planning/openstack/uefi-secure-boot-planning.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/openstack/virtual-or-cloud-networks.rst b/doc/source/planning/openstack/virtual-or-cloud-networks.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/openstack/vlan-aware-vms.rst b/doc/source/planning/openstack/vlan-aware-vms.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/openstack/vm-network-interface-options.rst b/doc/source/planning/openstack/vm-network-interface-options.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/openstack/vm-storage-settings-for-migration-resize-or-evacuation.rst b/doc/source/planning/openstack/vm-storage-settings-for-migration-resize-or-evacuation.rst old mode 100755 new mode 100644 diff --git a/doc/source/planning/openstack/vxlans.rst b/doc/source/planning/openstack/vxlans.rst old mode 100755 new mode 100644 diff --git a/doc/source/releasenotes/r5_release.rst b/doc/source/releasenotes/r5_release.rst index b90c981ef..2e6ec298c 100644 --- a/doc/source/releasenotes/r5_release.rst +++ b/doc/source/releasenotes/r5_release.rst @@ -27,7 +27,7 @@ Deployment A system install is required to deploy StarlingX release 5.0. There is no upgrade path from previous StarlingX releases. For detailed instructions, see -the :doc:`R5.0 Installation Guides `. +the :ref:`index-install-r5-ca4053cb3ab9`. ----------------------------- New features and enhancements @@ -47,9 +47,9 @@ associated user guides (if applicable). Added support for orchestrating updates to the Intel N3000 FPGA Programmable Acceleration Card across the subclouds in a distributed cloud configuration. - + Guide: :ref:`Device Image Update - Orchestration ` + Orchestration ` * Automatic certificate renewal for DC admin endpoints diff --git a/doc/source/security/index.rst b/doc/source/security/index-security-84d0d8aa401b.rst similarity index 86% rename from doc/source/security/index.rst rename to doc/source/security/index-security-84d0d8aa401b.rst index 7439ea03d..179fff288 100644 --- a/doc/source/security/index.rst +++ b/doc/source/security/index-security-84d0d8aa401b.rst @@ -1,3 +1,5 @@ +.. _index-security-84d0d8aa401b: + ======== Security ======== @@ -37,7 +39,7 @@ Contents: .. toctree:: :maxdepth: 2 - kubernetes/index + kubernetes/index-security-kub-81153c1254c3 --------- OpenStack @@ -50,4 +52,4 @@ OpenStack .. toctree:: :maxdepth: 2 - openstack/index \ No newline at end of file + openstack/index-security-os-a2375141dcc2 \ No newline at end of file diff --git a/doc/source/security/kubernetes/index.rst b/doc/source/security/kubernetes/index-security-kub-81153c1254c3.rst similarity index 98% rename from doc/source/security/kubernetes/index.rst rename to doc/source/security/kubernetes/index-security-kub-81153c1254c3.rst index 7f863082b..bcc2cfbad 100644 --- a/doc/source/security/kubernetes/index.rst +++ b/doc/source/security/kubernetes/index-security-kub-81153c1254c3.rst @@ -1,10 +1,10 @@ -.. _security-kubernetes-index: +.. _index-security-kub-81153c1254c3: .. include:: /_includes/toc-title-security-kub.rest .. only:: partner - .. include:: /security/index.rst + .. include:: /security/index-security-84d0d8aa401b.rst :start-after: kub-begin :end-before: kub-end diff --git a/doc/source/security/openstack/index.rst b/doc/source/security/openstack/index-security-os-a2375141dcc2.rst similarity index 94% rename from doc/source/security/openstack/index.rst rename to doc/source/security/openstack/index-security-os-a2375141dcc2.rst index 3dc0f97ca..2c1c12aba 100644 --- a/doc/source/security/openstack/index.rst +++ b/doc/source/security/openstack/index-security-os-a2375141dcc2.rst @@ -1,4 +1,4 @@ -.. _security-openstack-index: +.. _index-security-os-a2375141dcc2: .. include:: /_includes/toc-title-security-os.rest diff --git a/doc/source/shared/abbrevs.txt b/doc/source/shared/abbrevs.txt old mode 100755 new mode 100644 diff --git a/doc/source/storage/index.rst b/doc/source/storage/index-storage-6cd708f1ada9.rst similarity index 83% rename from doc/source/storage/index.rst rename to doc/source/storage/index-storage-6cd708f1ada9.rst index d60e13060..c02806e8c 100644 --- a/doc/source/storage/index.rst +++ b/doc/source/storage/index-storage-6cd708f1ada9.rst @@ -1,3 +1,5 @@ +.. _index-storage-6cd708f1ada9: + ======= Storage ======= @@ -18,7 +20,7 @@ and the requirements of the system. .. toctree:: :maxdepth: 2 - kubernetes/index + kubernetes/index-storage-kub-e797132c87a8 --------- OpenStack @@ -35,4 +37,4 @@ The storage management of hosts is not specific to |prod-os|. .. toctree:: :maxdepth: 2 - openstack/index \ No newline at end of file + openstack/index-storage-os-749707d7b5ab \ No newline at end of file diff --git a/doc/source/storage/kubernetes/index.rst b/doc/source/storage/kubernetes/index-storage-kub-e797132c87a8.rst similarity index 97% rename from doc/source/storage/kubernetes/index.rst rename to doc/source/storage/kubernetes/index-storage-kub-e797132c87a8.rst index 33059838f..0d091acf8 100644 --- a/doc/source/storage/kubernetes/index.rst +++ b/doc/source/storage/kubernetes/index-storage-kub-e797132c87a8.rst @@ -1,10 +1,10 @@ -.. _storage-kubernetes-index: +.. _index-storage-kub-e797132c87a8: .. include:: /_includes/toc-title-storage-kub.rest .. only:: partner - .. include:: /storage/index.rst + .. include:: /storage/index-storage-6cd708f1ada9.rst :start-after: kub-begin :end-before: kub-end diff --git a/doc/source/storage/openstack/index.rst b/doc/source/storage/openstack/index-storage-os-749707d7b5ab.rst similarity index 96% rename from doc/source/storage/openstack/index.rst rename to doc/source/storage/openstack/index-storage-os-749707d7b5ab.rst index 060db9a7d..95d0569e7 100644 --- a/doc/source/storage/openstack/index.rst +++ b/doc/source/storage/openstack/index-storage-os-749707d7b5ab.rst @@ -1,4 +1,4 @@ -.. _storage-openstack-index: +.. _index-storage-os-749707d7b5ab: .. include:: /_includes/toc-title-storage-os.rest diff --git a/doc/source/system_configuration/index.rst b/doc/source/system_configuration/index-sysconf-d511820651f0.rst similarity index 85% rename from doc/source/system_configuration/index.rst rename to doc/source/system_configuration/index-sysconf-d511820651f0.rst index 04eebaeba..569ee9349 100644 --- a/doc/source/system_configuration/index.rst +++ b/doc/source/system_configuration/index-sysconf-d511820651f0.rst @@ -1,4 +1,4 @@ -.. _sysconf_main_index: +.. _index-sysconf-d511820651f0: ==================== System Configuration @@ -19,7 +19,7 @@ and to set additional system configuration data. .. toctree:: :maxdepth: 2 - kubernetes/index.rst + kubernetes/index-sysconf-kub-78f0e1e9ca5a ------------------- StarlingX OpenStack @@ -38,4 +38,4 @@ OpenStack service. .. toctree:: :maxdepth: 3 - openstack/index.rst + openstack/index-sysconf-os-988a21c687cb diff --git a/doc/source/system_configuration/kubernetes/index.rst b/doc/source/system_configuration/kubernetes/index-sysconf-kub-78f0e1e9ca5a.rst similarity index 96% rename from doc/source/system_configuration/kubernetes/index.rst rename to doc/source/system_configuration/kubernetes/index-sysconf-kub-78f0e1e9ca5a.rst index 9c2acab5d..08e13d352 100644 --- a/doc/source/system_configuration/kubernetes/index.rst +++ b/doc/source/system_configuration/kubernetes/index-sysconf-kub-78f0e1e9ca5a.rst @@ -1,10 +1,10 @@ -.. _sysconf_kubernetes_index: +.. _index-sysconf-kub-78f0e1e9ca5a: .. include:: /_includes/toc-title-sys-conf-kub.rest .. only:: partner - .. include:: /system_configuration/index.rst + .. include:: /system_configuration/index-sysconf-d511820651f0.rst :start-after: kub-begin :end-before: kub-end diff --git a/doc/source/system_configuration/openstack/index.rst b/doc/source/system_configuration/openstack/index-sysconf-os-988a21c687cb.rst similarity index 90% rename from doc/source/system_configuration/openstack/index.rst rename to doc/source/system_configuration/openstack/index-sysconf-os-988a21c687cb.rst index d00448331..f165179a8 100644 --- a/doc/source/system_configuration/openstack/index.rst +++ b/doc/source/system_configuration/openstack/index-sysconf-os-988a21c687cb.rst @@ -1,10 +1,10 @@ -.. _sysconf_openstack_index: +.. _index-sysconf-os-988a21c687cb: .. include:: /_includes/toc-title-sys-conf-os.rest .. only:: partner - .. include:: /system_configuration/index.rst + .. include:: /system_configuration/index-sysconf-d511820651f0.rst :start-after: os-begin :end-before: os-end diff --git a/doc/source/updates/index.rst b/doc/source/updates/index-updates-e3b970bb69ce.rst similarity index 71% rename from doc/source/updates/index.rst rename to doc/source/updates/index-updates-e3b970bb69ce.rst index 6cedda2f6..2e0ba6af9 100644 --- a/doc/source/updates/index.rst +++ b/doc/source/updates/index-updates-e3b970bb69ce.rst @@ -1,3 +1,5 @@ +.. _index-updates-e3b970bb69ce: + ==================== Updates and Upgrades ==================== @@ -16,7 +18,7 @@ all hosts of an entire |prod-long| cloud to be updated with a single operation. .. toctree:: :maxdepth: 2 - kubernetes/index + kubernetes/index-updates-kub-03d4d10fa0be --------- @@ -25,7 +27,7 @@ Openstack .. os-begin -The system application-update -n |prefix|-openstack -v +The :command:`system application-update -n |prefix|-openstack -v ` command is used for corrective content \(bug fixes\) -type updates to the running containerized openstack application. @@ -34,4 +36,4 @@ running containerized openstack application. .. toctree:: :maxdepth: 2 - openstack/index + openstack/index-updates-os-5e0354d270cb diff --git a/doc/source/updates/kubernetes/index.rst b/doc/source/updates/kubernetes/index-updates-kub-03d4d10fa0be.rst similarity index 97% rename from doc/source/updates/kubernetes/index.rst rename to doc/source/updates/kubernetes/index-updates-kub-03d4d10fa0be.rst index 7b7e14356..89b40b846 100644 --- a/doc/source/updates/kubernetes/index.rst +++ b/doc/source/updates/kubernetes/index-updates-kub-03d4d10fa0be.rst @@ -1,11 +1,11 @@ -.. _updates_kubernetes_index: +.. _index-updates-kub-03d4d10fa0be: .. include:: /_includes/toc-title-updates-kub.rest .. only:: partner - .. include:: /updates/index.rst + .. include:: /updates/index-updates-e3b970bb69ce.rst :start-after: kub-begin :end-before: kub-end diff --git a/doc/source/updates/openstack/index.rst b/doc/source/updates/openstack/index-updates-os-5e0354d270cb.rst similarity index 65% rename from doc/source/updates/openstack/index.rst rename to doc/source/updates/openstack/index-updates-os-5e0354d270cb.rst index 25ca803c6..59979681d 100644 --- a/doc/source/updates/openstack/index.rst +++ b/doc/source/updates/openstack/index-updates-os-5e0354d270cb.rst @@ -1,11 +1,11 @@ -.. _updates_openstack_index: +.. _index-updates-os-5e0354d270cb: .. include:: /_includes/toc-title-updates-os.rest .. only:: partner - .. include:: /updates/index.rst + .. include:: /updates/index-updates-e3b970bb69ce.rst :start-after: os-begin :end-before: os-end diff --git a/doc/source/usertasks/index.rst b/doc/source/usertasks/index-usertasks-b18b379ab832.rst similarity index 70% rename from doc/source/usertasks/index.rst rename to doc/source/usertasks/index-usertasks-b18b379ab832.rst index 9533a3ead..ab7ba1920 100644 --- a/doc/source/usertasks/index.rst +++ b/doc/source/usertasks/index-usertasks-b18b379ab832.rst @@ -1,3 +1,5 @@ +.. _index-usertasks-b18b379ab832: + ========== User Tasks ========== @@ -16,7 +18,7 @@ end-user tasks. .. toctree:: :maxdepth: 2 - kubernetes/index + kubernetes/index-usertasks-kub-1291759aa985 .. only:: partner @@ -28,5 +30,5 @@ end-user tasks. .. toctree:: :maxdepth: 2 - openstack/index + openstack/index-usertasks-os-b137d0020741 diff --git a/doc/source/usertasks/kubernetes/index.rst b/doc/source/usertasks/kubernetes/index-usertasks-kub-1291759aa985.rst similarity index 97% rename from doc/source/usertasks/kubernetes/index.rst rename to doc/source/usertasks/kubernetes/index-usertasks-kub-1291759aa985.rst index dcc83aa8f..0e88d0ee4 100644 --- a/doc/source/usertasks/kubernetes/index.rst +++ b/doc/source/usertasks/kubernetes/index-usertasks-kub-1291759aa985.rst @@ -1,10 +1,10 @@ -.. _usertasks-kubernetes-index: +.. _index-usertasks-kub-1291759aa985: .. include:: /_includes/toc-title-usertasks-kub.rest .. only:: partner - .. include:: /usertasks/index.rst + .. include:: /usertasks/index-usertasks-b18b379ab832.rst :start-after: kub-begin :end-before: kub-end diff --git a/doc/source/usertasks/openstack/index.rst b/doc/source/usertasks/openstack/index-usertasks-os-b137d0020741.rst similarity index 54% rename from doc/source/usertasks/openstack/index.rst rename to doc/source/usertasks/openstack/index-usertasks-os-b137d0020741.rst index a6971e030..be99b46d3 100644 --- a/doc/source/usertasks/openstack/index.rst +++ b/doc/source/usertasks/openstack/index-usertasks-os-b137d0020741.rst @@ -1 +1,3 @@ +.. _index-usertasks-os-b137d0020741: + .. Needed for partner builds. Do not delete.