From aeb5306093879be957e0557069b90273ce2ed056 Mon Sep 17 00:00:00 2001 From: Sam Betts Date: Mon, 3 Jul 2017 16:24:24 +0100 Subject: [PATCH] Move install guide into new doc/source/install location Change-Id: I7d853142aaf794869466a1ba1bfaa82fd8851b7a --- doc/source/index.rst | 2 +- {install-guide/source => doc/source/install}/advanced.rst | 0 {install-guide/source => doc/source/install}/conf.py | 0 {install-guide/source => doc/source/install}/configdrive.rst | 0 .../source => doc/source/install}/configure-cleaning.rst | 0 .../source => doc/source/install}/configure-compute.rst | 0 .../source => doc/source/install}/configure-glance-images.rst | 0 .../source => doc/source/install}/configure-glance-swift.rst | 0 .../source => doc/source/install}/configure-identity.rst | 0 .../source => doc/source/install}/configure-integration.rst | 0 {install-guide/source => doc/source/install}/configure-ipmi.rst | 0 .../source => doc/source/install}/configure-iscsi.rst | 0 .../source => doc/source/install}/configure-networking.rst | 0 .../source => doc/source/install}/configure-nova-flavors.rst | 0 {install-guide/source => doc/source/install}/configure-pxe.rst | 0 .../source => doc/source/install}/configure-tenant-networks.rst | 0 {install-guide/source => doc/source/install}/deploy-ramdisk.rst | 0 .../source => doc/source/install}/enabling-drivers.rst | 0 {install-guide/source => doc/source/install}/enabling-https.rst | 0 {install-guide/source => doc/source/install}/enrollment.rst | 2 +- {install-guide/source => doc/source/install}/get_started.rst | 0 .../source => doc/source/install}/include/boot-mode.rst | 0 .../source => doc/source/install}/include/common-configure.rst | 0 .../source/install}/include/common-prerequisites.rst | 0 .../source/install}/include/configure-ironic-api-mod_wsgi.rst | 0 .../source/install}/include/configure-ironic-api.rst | 0 .../source/install}/include/configure-ironic-conductor.rst | 2 +- .../source => doc/source/install}/include/console.rst | 0 .../source => doc/source/install}/include/disk-label.rst | 0 .../source/install}/include/kernel-boot-parameters.rst | 0 .../source/install}/include/local-boot-partition-images.rst | 0 .../source => doc/source/install}/include/notifications.rst | 0 .../source => doc/source/install}/include/root-device-hints.rst | 0 .../source => doc/source/install}/include/trusted-boot.rst | 0 {install-guide/source => doc/source/install}/index.rst | 0 {install-guide/source => doc/source/install}/install-obs.rst | 0 {install-guide/source => doc/source/install}/install-rdo.rst | 0 {install-guide/source => doc/source/install}/install-ubuntu.rst | 0 {install-guide/source => doc/source/install}/install.rst | 0 {install-guide/source => doc/source/install}/next-steps.rst | 0 {install-guide/source => doc/source/install}/setup-drivers.rst | 0 {install-guide/source => doc/source/install}/standalone.rst | 0 .../source => doc/source/install}/troubleshooting.rst | 2 +- tox.ini | 2 +- 44 files changed, 5 insertions(+), 5 deletions(-) rename {install-guide/source => doc/source/install}/advanced.rst (100%) rename {install-guide/source => doc/source/install}/conf.py (100%) rename {install-guide/source => doc/source/install}/configdrive.rst (100%) rename {install-guide/source => doc/source/install}/configure-cleaning.rst (100%) rename {install-guide/source => doc/source/install}/configure-compute.rst (100%) rename {install-guide/source => doc/source/install}/configure-glance-images.rst (100%) rename {install-guide/source => doc/source/install}/configure-glance-swift.rst (100%) rename {install-guide/source => doc/source/install}/configure-identity.rst (100%) rename {install-guide/source => doc/source/install}/configure-integration.rst (100%) rename {install-guide/source => doc/source/install}/configure-ipmi.rst (100%) rename {install-guide/source => doc/source/install}/configure-iscsi.rst (100%) rename {install-guide/source => doc/source/install}/configure-networking.rst (100%) rename {install-guide/source => doc/source/install}/configure-nova-flavors.rst (100%) rename {install-guide/source => doc/source/install}/configure-pxe.rst (100%) rename {install-guide/source => doc/source/install}/configure-tenant-networks.rst (100%) rename {install-guide/source => doc/source/install}/deploy-ramdisk.rst (100%) rename {install-guide/source => doc/source/install}/enabling-drivers.rst (100%) rename {install-guide/source => doc/source/install}/enabling-https.rst (100%) rename {install-guide/source => doc/source/install}/enrollment.rst (99%) rename {install-guide/source => doc/source/install}/get_started.rst (100%) rename {install-guide/source => doc/source/install}/include/boot-mode.rst (100%) rename {install-guide/source => doc/source/install}/include/common-configure.rst (100%) rename {install-guide/source => doc/source/install}/include/common-prerequisites.rst (100%) rename {install-guide/source => doc/source/install}/include/configure-ironic-api-mod_wsgi.rst (100%) rename {install-guide/source => doc/source/install}/include/configure-ironic-api.rst (100%) rename {install-guide/source => doc/source/install}/include/configure-ironic-conductor.rst (99%) rename {install-guide/source => doc/source/install}/include/console.rst (100%) rename {install-guide/source => doc/source/install}/include/disk-label.rst (100%) rename {install-guide/source => doc/source/install}/include/kernel-boot-parameters.rst (100%) rename {install-guide/source => doc/source/install}/include/local-boot-partition-images.rst (100%) rename {install-guide/source => doc/source/install}/include/notifications.rst (100%) rename {install-guide/source => doc/source/install}/include/root-device-hints.rst (100%) rename {install-guide/source => doc/source/install}/include/trusted-boot.rst (100%) rename {install-guide/source => doc/source/install}/index.rst (100%) rename {install-guide/source => doc/source/install}/install-obs.rst (100%) rename {install-guide/source => doc/source/install}/install-rdo.rst (100%) rename {install-guide/source => doc/source/install}/install-ubuntu.rst (100%) rename {install-guide/source => doc/source/install}/install.rst (100%) rename {install-guide/source => doc/source/install}/next-steps.rst (100%) rename {install-guide/source => doc/source/install}/setup-drivers.rst (100%) rename {install-guide/source => doc/source/install}/standalone.rst (100%) rename {install-guide/source => doc/source/install}/troubleshooting.rst (99%) diff --git a/doc/source/index.rst b/doc/source/index.rst index 005e2acfce..1750509515 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -140,7 +140,7 @@ the services. .. toctree:: :maxdepth: 1 - Installation Guide + Installation Guide gmr Upgrade Guide Release Notes diff --git a/install-guide/source/advanced.rst b/doc/source/install/advanced.rst similarity index 100% rename from install-guide/source/advanced.rst rename to doc/source/install/advanced.rst diff --git a/install-guide/source/conf.py b/doc/source/install/conf.py similarity index 100% rename from install-guide/source/conf.py rename to doc/source/install/conf.py diff --git a/install-guide/source/configdrive.rst b/doc/source/install/configdrive.rst similarity index 100% rename from install-guide/source/configdrive.rst rename to doc/source/install/configdrive.rst diff --git a/install-guide/source/configure-cleaning.rst b/doc/source/install/configure-cleaning.rst similarity index 100% rename from install-guide/source/configure-cleaning.rst rename to doc/source/install/configure-cleaning.rst diff --git a/install-guide/source/configure-compute.rst b/doc/source/install/configure-compute.rst similarity index 100% rename from install-guide/source/configure-compute.rst rename to doc/source/install/configure-compute.rst diff --git a/install-guide/source/configure-glance-images.rst b/doc/source/install/configure-glance-images.rst similarity index 100% rename from install-guide/source/configure-glance-images.rst rename to doc/source/install/configure-glance-images.rst diff --git a/install-guide/source/configure-glance-swift.rst b/doc/source/install/configure-glance-swift.rst similarity index 100% rename from install-guide/source/configure-glance-swift.rst rename to doc/source/install/configure-glance-swift.rst diff --git a/install-guide/source/configure-identity.rst b/doc/source/install/configure-identity.rst similarity index 100% rename from install-guide/source/configure-identity.rst rename to doc/source/install/configure-identity.rst diff --git a/install-guide/source/configure-integration.rst b/doc/source/install/configure-integration.rst similarity index 100% rename from install-guide/source/configure-integration.rst rename to doc/source/install/configure-integration.rst diff --git a/install-guide/source/configure-ipmi.rst b/doc/source/install/configure-ipmi.rst similarity index 100% rename from install-guide/source/configure-ipmi.rst rename to doc/source/install/configure-ipmi.rst diff --git a/install-guide/source/configure-iscsi.rst b/doc/source/install/configure-iscsi.rst similarity index 100% rename from install-guide/source/configure-iscsi.rst rename to doc/source/install/configure-iscsi.rst diff --git a/install-guide/source/configure-networking.rst b/doc/source/install/configure-networking.rst similarity index 100% rename from install-guide/source/configure-networking.rst rename to doc/source/install/configure-networking.rst diff --git a/install-guide/source/configure-nova-flavors.rst b/doc/source/install/configure-nova-flavors.rst similarity index 100% rename from install-guide/source/configure-nova-flavors.rst rename to doc/source/install/configure-nova-flavors.rst diff --git a/install-guide/source/configure-pxe.rst b/doc/source/install/configure-pxe.rst similarity index 100% rename from install-guide/source/configure-pxe.rst rename to doc/source/install/configure-pxe.rst diff --git a/install-guide/source/configure-tenant-networks.rst b/doc/source/install/configure-tenant-networks.rst similarity index 100% rename from install-guide/source/configure-tenant-networks.rst rename to doc/source/install/configure-tenant-networks.rst diff --git a/install-guide/source/deploy-ramdisk.rst b/doc/source/install/deploy-ramdisk.rst similarity index 100% rename from install-guide/source/deploy-ramdisk.rst rename to doc/source/install/deploy-ramdisk.rst diff --git a/install-guide/source/enabling-drivers.rst b/doc/source/install/enabling-drivers.rst similarity index 100% rename from install-guide/source/enabling-drivers.rst rename to doc/source/install/enabling-drivers.rst diff --git a/install-guide/source/enabling-https.rst b/doc/source/install/enabling-https.rst similarity index 100% rename from install-guide/source/enabling-https.rst rename to doc/source/install/enabling-https.rst diff --git a/install-guide/source/enrollment.rst b/doc/source/install/enrollment.rst similarity index 99% rename from install-guide/source/enrollment.rst rename to doc/source/install/enrollment.rst index 21cc0d689b..dfa0e8d0ba 100644 --- a/install-guide/source/enrollment.rst +++ b/doc/source/install/enrollment.rst @@ -14,7 +14,7 @@ they are in the ``available`` provision state. resource tracker syncs periodically, and so any changes made directly to the Bare Metal service's resources will become visible in the Compute service only after the next run of that periodic task. - More information is in the :ref:`troubleshooting` section. + More information is in the :ref:`troubleshooting-install` section. .. note:: Any bare metal node that is visible to the Compute service may have a diff --git a/install-guide/source/get_started.rst b/doc/source/install/get_started.rst similarity index 100% rename from install-guide/source/get_started.rst rename to doc/source/install/get_started.rst diff --git a/install-guide/source/include/boot-mode.rst b/doc/source/install/include/boot-mode.rst similarity index 100% rename from install-guide/source/include/boot-mode.rst rename to doc/source/install/include/boot-mode.rst diff --git a/install-guide/source/include/common-configure.rst b/doc/source/install/include/common-configure.rst similarity index 100% rename from install-guide/source/include/common-configure.rst rename to doc/source/install/include/common-configure.rst diff --git a/install-guide/source/include/common-prerequisites.rst b/doc/source/install/include/common-prerequisites.rst similarity index 100% rename from install-guide/source/include/common-prerequisites.rst rename to doc/source/install/include/common-prerequisites.rst diff --git a/install-guide/source/include/configure-ironic-api-mod_wsgi.rst b/doc/source/install/include/configure-ironic-api-mod_wsgi.rst similarity index 100% rename from install-guide/source/include/configure-ironic-api-mod_wsgi.rst rename to doc/source/install/include/configure-ironic-api-mod_wsgi.rst diff --git a/install-guide/source/include/configure-ironic-api.rst b/doc/source/install/include/configure-ironic-api.rst similarity index 100% rename from install-guide/source/include/configure-ironic-api.rst rename to doc/source/install/include/configure-ironic-api.rst diff --git a/install-guide/source/include/configure-ironic-conductor.rst b/doc/source/install/include/configure-ironic-conductor.rst similarity index 99% rename from install-guide/source/include/configure-ironic-conductor.rst rename to doc/source/install/include/configure-ironic-conductor.rst index 235cd939a5..b148d131e5 100644 --- a/install-guide/source/include/configure-ironic-conductor.rst +++ b/doc/source/install/include/configure-ironic-conductor.rst @@ -160,7 +160,7 @@ Configuring ironic-conductor service cafile=/opt/stack/data/ca-bundle.pem #. Configure enabled drivers and hardware types as described in - :doc:`enabling-drivers`. + :doc:`/install/enabling-drivers`. #. Restart the ironic-conductor service: diff --git a/install-guide/source/include/console.rst b/doc/source/install/include/console.rst similarity index 100% rename from install-guide/source/include/console.rst rename to doc/source/install/include/console.rst diff --git a/install-guide/source/include/disk-label.rst b/doc/source/install/include/disk-label.rst similarity index 100% rename from install-guide/source/include/disk-label.rst rename to doc/source/install/include/disk-label.rst diff --git a/install-guide/source/include/kernel-boot-parameters.rst b/doc/source/install/include/kernel-boot-parameters.rst similarity index 100% rename from install-guide/source/include/kernel-boot-parameters.rst rename to doc/source/install/include/kernel-boot-parameters.rst diff --git a/install-guide/source/include/local-boot-partition-images.rst b/doc/source/install/include/local-boot-partition-images.rst similarity index 100% rename from install-guide/source/include/local-boot-partition-images.rst rename to doc/source/install/include/local-boot-partition-images.rst diff --git a/install-guide/source/include/notifications.rst b/doc/source/install/include/notifications.rst similarity index 100% rename from install-guide/source/include/notifications.rst rename to doc/source/install/include/notifications.rst diff --git a/install-guide/source/include/root-device-hints.rst b/doc/source/install/include/root-device-hints.rst similarity index 100% rename from install-guide/source/include/root-device-hints.rst rename to doc/source/install/include/root-device-hints.rst diff --git a/install-guide/source/include/trusted-boot.rst b/doc/source/install/include/trusted-boot.rst similarity index 100% rename from install-guide/source/include/trusted-boot.rst rename to doc/source/install/include/trusted-boot.rst diff --git a/install-guide/source/index.rst b/doc/source/install/index.rst similarity index 100% rename from install-guide/source/index.rst rename to doc/source/install/index.rst diff --git a/install-guide/source/install-obs.rst b/doc/source/install/install-obs.rst similarity index 100% rename from install-guide/source/install-obs.rst rename to doc/source/install/install-obs.rst diff --git a/install-guide/source/install-rdo.rst b/doc/source/install/install-rdo.rst similarity index 100% rename from install-guide/source/install-rdo.rst rename to doc/source/install/install-rdo.rst diff --git a/install-guide/source/install-ubuntu.rst b/doc/source/install/install-ubuntu.rst similarity index 100% rename from install-guide/source/install-ubuntu.rst rename to doc/source/install/install-ubuntu.rst diff --git a/install-guide/source/install.rst b/doc/source/install/install.rst similarity index 100% rename from install-guide/source/install.rst rename to doc/source/install/install.rst diff --git a/install-guide/source/next-steps.rst b/doc/source/install/next-steps.rst similarity index 100% rename from install-guide/source/next-steps.rst rename to doc/source/install/next-steps.rst diff --git a/install-guide/source/setup-drivers.rst b/doc/source/install/setup-drivers.rst similarity index 100% rename from install-guide/source/setup-drivers.rst rename to doc/source/install/setup-drivers.rst diff --git a/install-guide/source/standalone.rst b/doc/source/install/standalone.rst similarity index 100% rename from install-guide/source/standalone.rst rename to doc/source/install/standalone.rst diff --git a/install-guide/source/troubleshooting.rst b/doc/source/install/troubleshooting.rst similarity index 99% rename from install-guide/source/troubleshooting.rst rename to doc/source/install/troubleshooting.rst index cca09b6552..6e51c3c2b3 100644 --- a/install-guide/source/troubleshooting.rst +++ b/doc/source/install/troubleshooting.rst @@ -1,4 +1,4 @@ -.. _troubleshooting: +.. _troubleshooting-install: =============== Troubleshooting diff --git a/tox.ini b/tox.ini index b6c716bc19..fc9ad55c7e 100644 --- a/tox.ini +++ b/tox.ini @@ -39,7 +39,7 @@ commands = # Check that .po and .pot files are valid: bash -c "find ironic -type f -regex '.*\.pot?' -print0|xargs -0 -n 1 msgfmt --check-format -o /dev/null" # Check the *.rst files - doc8 README.rst CONTRIBUTING.rst doc/source install-guide/ --ignore D001 + doc8 README.rst CONTRIBUTING.rst doc/source --ignore D001 [testenv:cover] setenv = VIRTUAL_ENV={envdir}