From 4e6eec5c9beb0086ab370f5506ab73efe1705631 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Wed, 6 Sep 2017 22:01:01 +0200 Subject: [PATCH] Fix broken URLs Fix broken nova URLs that linked to the old developer/nova places and use the new link instead. Change-Id: Ideb50626e140201dded19fc82584440f1a407e47 --- MAINTAINERS | 2 +- api-guide/source/general_info.rst | 2 +- api-ref/source/os-availability-zone.inc | 3 ++- api-ref/source/os-hosts.inc | 2 +- api-ref/source/os-quota-class-sets.inc | 2 +- api-ref/source/servers-admin-action.inc | 2 +- api-ref/source/versions.inc | 4 ++-- doc/README.rst | 6 +++--- doc/source/admin/arch.rst | 3 +-- doc/source/admin/configuring-migrations.rst | 10 ++++------ doc/source/admin/support-compute.rst | 3 +-- doc/source/cli/nova-api-metadata.rst | 4 ++-- doc/source/cli/nova-api-os-compute.rst | 4 ++-- doc/source/cli/nova-api.rst | 4 ++-- doc/source/cli/nova-cells.rst | 2 +- doc/source/cli/nova-compute.rst | 2 +- doc/source/cli/nova-conductor.rst | 2 +- doc/source/cli/nova-console.rst | 2 +- doc/source/cli/nova-consoleauth.rst | 2 +- doc/source/cli/nova-dhcpbridge.rst | 2 +- doc/source/cli/nova-idmapshift.rst | 2 +- doc/source/cli/nova-manage.rst | 2 +- doc/source/cli/nova-network.rst | 2 +- doc/source/cli/nova-novncproxy.rst | 2 +- doc/source/cli/nova-rootwrap.rst | 2 +- doc/source/cli/nova-scheduler.rst | 2 +- doc/source/cli/nova-serialproxy.rst | 2 +- doc/source/cli/nova-spicehtml5proxy.rst | 2 +- doc/source/cli/nova-status.rst | 4 ++-- doc/source/cli/nova-xvpvncproxy.rst | 2 +- .../contributor/testing/zero-downtime-upgrade.rst | 4 ++-- doc/source/install/get-started-compute.rst | 4 ++-- doc/source/user/upgrade.rst | 1 + etc/nova/README-nova.conf.txt | 2 +- nova/cmd/status.py | 3 ++- nova/conf/notifications.py | 6 +++--- nova/conf/scheduler.py | 2 +- nova/virt/libvirt/driver.py | 4 ++-- placement-api-ref/source/index.rst | 2 +- 39 files changed, 56 insertions(+), 57 deletions(-) diff --git a/MAINTAINERS b/MAINTAINERS index 3fd6075f1a9f..f3f2bfd209ee 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -12,6 +12,6 @@ We also have a page which documents tips and mentoring opportunities for new Nova developers at https://wiki.openstack.org/wiki/Nova/Mentoring Finally, you should also check out our developer reference at -http://docs.openstack.org/developer/nova/devref/ +https://docs.openstack.org/nova/latest/contributor/index.html Thanks for your interest in Nova, please come again! diff --git a/api-guide/source/general_info.rst b/api-guide/source/general_info.rst index a6bcf8c04b37..c563af68bd44 100644 --- a/api-guide/source/general_info.rst +++ b/api-guide/source/general_info.rst @@ -242,7 +242,7 @@ on compute hosts rather than servers. - **Aggregates** See `Aggregates developer information - `_. + `_. - **Migrations** diff --git a/api-ref/source/os-availability-zone.inc b/api-ref/source/os-availability-zone.inc index 7a54b390b707..9869dc596c32 100644 --- a/api-ref/source/os-availability-zone.inc +++ b/api-ref/source/os-availability-zone.inc @@ -9,7 +9,8 @@ Lists and gets detailed availability zone information. An availability zone is created or updated by setting the availability_zone parameter in the ``create``, ``update``, or ``create or update`` methods of the Host Aggregates API. -See `Host Aggregates `_ +See `Host Aggregates +`_ for more details. diff --git a/api-ref/source/os-hosts.inc b/api-ref/source/os-hosts.inc index 89b93db94bc5..d3086231458d 100644 --- a/api-ref/source/os-hosts.inc +++ b/api-ref/source/os-hosts.inc @@ -16,7 +16,7 @@ Manages physical hosts. Some virt drivers do not support all host functions. For more information, see `nova virt support -matrix `__ +matrix `__ Policy defaults enable only users with the administrative role to perform all os-hosts related operations. Cloud providers can change these permissions diff --git a/api-ref/source/os-quota-class-sets.inc b/api-ref/source/os-quota-class-sets.inc index fbb17c2c28db..d604409664ff 100644 --- a/api-ref/source/os-quota-class-sets.inc +++ b/api-ref/source/os-quota-class-sets.inc @@ -22,7 +22,7 @@ Nova supports implicit 'default' Quota Class only. update the ``default`` quota class via the API, you'll still have a default quota of 20 for instances regardless of ``nova.conf``. Refer: `Quotas - `__ + `__ for more details. .. warning:: diff --git a/api-ref/source/servers-admin-action.inc b/api-ref/source/servers-admin-action.inc index b7227d5c283a..9c3e6da8d363 100644 --- a/api-ref/source/servers-admin-action.inc +++ b/api-ref/source/servers-admin-action.inc @@ -26,7 +26,7 @@ through the ``policy.json`` file. .. warning:: There is very limited support on this API, For more information, see `nova virt support matrix - `__ + `__ Normal response codes: 202 diff --git a/api-ref/source/versions.inc b/api-ref/source/versions.inc index 2d07eb3c2f58..7af60604f258 100644 --- a/api-ref/source/versions.inc +++ b/api-ref/source/versions.inc @@ -14,12 +14,12 @@ supports versioning. There are two kinds of versions in Nova. For more details about Microversions, please reference: `Microversions -`_ +`_ .. note:: The maximum microversion supported by each release varies. Please reference: `API Microversion History - `__ + `__ for API microversion history details. The Version APIs work differently from other APIs as they *do not* diff --git a/doc/README.rst b/doc/README.rst index 306503658390..bfb708ac4572 100644 --- a/doc/README.rst +++ b/doc/README.rst @@ -5,10 +5,10 @@ Both contributor developer documentation and REST API documentation are sourced here. Contributor developer docs are built to: -http://docs.openstack.org/developer/nova/ +https://docs.openstack.org/nova/latest/ API guide docs are built to: -http://developer.openstack.org/api-guide/compute/ +https://developer.openstack.org/api-guide/compute/ For more details, see the "Building the Documentation" section of -doc/source/development.environment.rst. +doc/source/contributor/development.environment.rst. diff --git a/doc/source/admin/arch.rst b/doc/source/admin/arch.rst index 47012fbd24f9..c746bb3cfff3 100644 --- a/doc/source/admin/arch.rst +++ b/doc/source/admin/arch.rst @@ -44,8 +44,7 @@ hypervisor to use can be difficult, and you must take budget, resource constraints, supported features, and required technical specifications into account. However, the majority of OpenStack development is done on systems using KVM and Xen-based hypervisors. For a detailed list of features and -support across different hypervisors, see the `Feature Support Matrix -`_. +support across different hypervisors, see :doc:`/user/support-matrix`. You can also orchestrate clouds using multiple hypervisors in different availability zones. Compute supports the following hypervisors: diff --git a/doc/source/admin/configuring-migrations.rst b/doc/source/admin/configuring-migrations.rst index 69357f646bea..7f68c42e2722 100644 --- a/doc/source/admin/configuring-migrations.rst +++ b/doc/source/admin/configuring-migrations.rst @@ -21,13 +21,11 @@ This document covers live migrations using the Not all Compute service hypervisor drivers support live-migration, or support all live-migration features. - Consult the `Hypervisor Support Matrix - `_ to - determine which hypervisors support live-migration. + Consult :doc:`/user/support-matrix` to determine which hypervisors + support live-migration. - See the `Hypervisor configuration pages - `_ - for details on hypervisor-specific configuration settings. + See the :doc:`/configuration/index` for details + on hypervisor configuration settings. The migration types are: diff --git a/doc/source/admin/support-compute.rst b/doc/source/admin/support-compute.rst index 5a09061dcfdf..5c73a83943d0 100644 --- a/doc/source/admin/support-compute.rst +++ b/doc/source/admin/support-compute.rst @@ -64,8 +64,7 @@ The report has the following sections: * Configuration: Lists all configuration options currently accessible through the CONF object for the current process. -For more information, see `Guru Meditation Reports -`_. +For more information, see :doc:`/reference/gmr`. .. _compute-common-errors-and-fixes: diff --git a/doc/source/cli/nova-api-metadata.rst b/doc/source/cli/nova-api-metadata.rst index d55eb05fce56..c3192b818e87 100644 --- a/doc/source/cli/nova-api-metadata.rst +++ b/doc/source/cli/nova-api-metadata.rst @@ -40,8 +40,8 @@ FILES SEE ALSO ======== -* `OpenStack Nova `__ -* `Using WSGI with Nova `__ +* `OpenStack Nova `__ +* `Using WSGI with Nova `__ BUGS ==== diff --git a/doc/source/cli/nova-api-os-compute.rst b/doc/source/cli/nova-api-os-compute.rst index 4d687a53e1ae..febb4b4c5a4c 100644 --- a/doc/source/cli/nova-api-os-compute.rst +++ b/doc/source/cli/nova-api-os-compute.rst @@ -40,8 +40,8 @@ FILES SEE ALSO ======== -* `OpenStack Nova `__ -* `Using WSGI with Nova `__ +* `OpenStack Nova `__ +* `Using WSGI with Nova `__ BUGS ==== diff --git a/doc/source/cli/nova-api.rst b/doc/source/cli/nova-api.rst index 972f20264fa9..49acf96344cc 100644 --- a/doc/source/cli/nova-api.rst +++ b/doc/source/cli/nova-api.rst @@ -41,8 +41,8 @@ FILES SEE ALSO ======== -* `OpenStack Nova `__ -* `Using WSGI with Nova `__ +* `OpenStack Nova `__ +* `Using WSGI with Nova `__ BUGS ==== diff --git a/doc/source/cli/nova-cells.rst b/doc/source/cli/nova-cells.rst index 2b5fc92fd995..08a493c703d1 100644 --- a/doc/source/cli/nova-cells.rst +++ b/doc/source/cli/nova-cells.rst @@ -47,7 +47,7 @@ FILES SEE ALSO ======== -* `OpenStack Nova `__ +* `OpenStack Nova `__ BUGS ==== diff --git a/doc/source/cli/nova-compute.rst b/doc/source/cli/nova-compute.rst index 5f7deef37db7..bdce2308e373 100644 --- a/doc/source/cli/nova-compute.rst +++ b/doc/source/cli/nova-compute.rst @@ -42,7 +42,7 @@ FILES SEE ALSO ======== -* `OpenStack Nova `__ +* `OpenStack Nova `__ BUGS ==== diff --git a/doc/source/cli/nova-conductor.rst b/doc/source/cli/nova-conductor.rst index 1418d8ee7491..70cd7d137353 100644 --- a/doc/source/cli/nova-conductor.rst +++ b/doc/source/cli/nova-conductor.rst @@ -36,7 +36,7 @@ FILES SEE ALSO ======== -* `OpenStack Nova `__ +* `OpenStack Nova `__ BUGS ==== diff --git a/doc/source/cli/nova-console.rst b/doc/source/cli/nova-console.rst index 3b8094772993..53f7cb6246a1 100644 --- a/doc/source/cli/nova-console.rst +++ b/doc/source/cli/nova-console.rst @@ -39,7 +39,7 @@ FILES SEE ALSO ======== -* `OpenStack Nova `__ +* `OpenStack Nova `__ BUGS ==== diff --git a/doc/source/cli/nova-consoleauth.rst b/doc/source/cli/nova-consoleauth.rst index 33d273f3c790..ec27519593ca 100644 --- a/doc/source/cli/nova-consoleauth.rst +++ b/doc/source/cli/nova-consoleauth.rst @@ -39,7 +39,7 @@ FILES SEE ALSO ======== -* `OpenStack Nova `__ +* `OpenStack Nova `__ BUGS ==== diff --git a/doc/source/cli/nova-dhcpbridge.rst b/doc/source/cli/nova-dhcpbridge.rst index 504c7c6f20ed..2d78ca9ffc86 100644 --- a/doc/source/cli/nova-dhcpbridge.rst +++ b/doc/source/cli/nova-dhcpbridge.rst @@ -41,7 +41,7 @@ FILES SEE ALSO ======== -* `OpenStack Nova `__ +* `OpenStack Nova `__ BUGS ==== diff --git a/doc/source/cli/nova-idmapshift.rst b/doc/source/cli/nova-idmapshift.rst index 1b50ecd0c886..b747e2de25a0 100644 --- a/doc/source/cli/nova-idmapshift.rst +++ b/doc/source/cli/nova-idmapshift.rst @@ -84,7 +84,7 @@ Optional arguments SEE ALSO ======== -* `OpenStack Nova `__ +* `OpenStack Nova `__ BUGS ==== diff --git a/doc/source/cli/nova-manage.rst b/doc/source/cli/nova-manage.rst index ba3efdb9878a..149e3b990128 100644 --- a/doc/source/cli/nova-manage.rst +++ b/doc/source/cli/nova-manage.rst @@ -280,7 +280,7 @@ Nova Project SEE ALSO ======== -* `OpenStack Nova `__ +* `OpenStack Nova `__ BUGS ==== diff --git a/doc/source/cli/nova-network.rst b/doc/source/cli/nova-network.rst index 80a0ad33a1f8..2cf74f038642 100644 --- a/doc/source/cli/nova-network.rst +++ b/doc/source/cli/nova-network.rst @@ -39,7 +39,7 @@ FILES SEE ALSO ======== -* `OpenStack Nova `__ +* `OpenStack Nova `__ BUGS ==== diff --git a/doc/source/cli/nova-novncproxy.rst b/doc/source/cli/nova-novncproxy.rst index 2f61de421926..9f2a45776a50 100644 --- a/doc/source/cli/nova-novncproxy.rst +++ b/doc/source/cli/nova-novncproxy.rst @@ -40,7 +40,7 @@ FILES SEE ALSO ======== -* `OpenStack Nova `__ +* `OpenStack Nova `__ BUGS ==== diff --git a/doc/source/cli/nova-rootwrap.rst b/doc/source/cli/nova-rootwrap.rst index 2de5680bdffa..3739fe586995 100644 --- a/doc/source/cli/nova-rootwrap.rst +++ b/doc/source/cli/nova-rootwrap.rst @@ -50,7 +50,7 @@ FILES SEE ALSO ======== -* `OpenStack Nova `__ +* `OpenStack Nova `__ BUGS ==== diff --git a/doc/source/cli/nova-scheduler.rst b/doc/source/cli/nova-scheduler.rst index e849ad6adebf..29a2683a711b 100644 --- a/doc/source/cli/nova-scheduler.rst +++ b/doc/source/cli/nova-scheduler.rst @@ -39,7 +39,7 @@ FILES SEE ALSO ======== -* `OpenStack Nova `__ +* `OpenStack Nova `__ BUGS ==== diff --git a/doc/source/cli/nova-serialproxy.rst b/doc/source/cli/nova-serialproxy.rst index ffacfa160b47..eb0da7718afd 100644 --- a/doc/source/cli/nova-serialproxy.rst +++ b/doc/source/cli/nova-serialproxy.rst @@ -40,7 +40,7 @@ FILES SEE ALSO ======== -* `OpenStack Nova `__ +* `OpenStack Nova `__ BUGS ==== diff --git a/doc/source/cli/nova-spicehtml5proxy.rst b/doc/source/cli/nova-spicehtml5proxy.rst index b1ab3b590ffc..1311d9a872ae 100644 --- a/doc/source/cli/nova-spicehtml5proxy.rst +++ b/doc/source/cli/nova-spicehtml5proxy.rst @@ -40,7 +40,7 @@ FILES SEE ALSO ======== -* `OpenStack Nova `__ +* `OpenStack Nova `__ BUGS ==== diff --git a/doc/source/cli/nova-status.rst b/doc/source/cli/nova-status.rst index ae92a16db851..b9704a3cc39a 100644 --- a/doc/source/cli/nova-status.rst +++ b/doc/source/cli/nova-status.rst @@ -93,7 +93,7 @@ Upgrade make a successful request to the endpoint. The command also checks to see that there are compute node resource providers checking in with the Placement service. More information on the Placement service can be found - at: ``_ + at: ``_ **16.0.0 (Pike)** @@ -104,7 +104,7 @@ Upgrade SEE ALSO ======== -* OpenStack Nova Docs: ``_ +* OpenStack Nova Docs: ``_ BUGS ==== diff --git a/doc/source/cli/nova-xvpvncproxy.rst b/doc/source/cli/nova-xvpvncproxy.rst index 094fb0479004..a6c9f5ccba0d 100644 --- a/doc/source/cli/nova-xvpvncproxy.rst +++ b/doc/source/cli/nova-xvpvncproxy.rst @@ -39,7 +39,7 @@ FILES SEE ALSO ======== -* `OpenStack Nova `__ +* `OpenStack Nova `__ BUGS ==== diff --git a/doc/source/contributor/testing/zero-downtime-upgrade.rst b/doc/source/contributor/testing/zero-downtime-upgrade.rst index 097d72a6ba69..6dab61c328f8 100644 --- a/doc/source/contributor/testing/zero-downtime-upgrade.rst +++ b/doc/source/contributor/testing/zero-downtime-upgrade.rst @@ -158,8 +158,8 @@ claims the virtual IP. You can check which node claimed the virtual IP using: Zero Downtime upgrade process ------------------------------ -General rolling upgrade process: -http://docs.openstack.org/developer/nova/upgrade.html#minimal-downtime-upgrade-process +General rolling upgrade process: :ref:minimal_downtime_upgrade. + Before Upgrade '''''''''''''' diff --git a/doc/source/install/get-started-compute.rst b/doc/source/install/get-started-compute.rst index 87ee51d0ae3c..a3cd6a4522f8 100644 --- a/doc/source/install/get-started-compute.rst +++ b/doc/source/install/get-started-compute.rst @@ -45,8 +45,8 @@ OpenStack Compute consists of the following areas and their components: instance and updating its state in the database. ``nova-placement-api`` service - Tracks the inventory and usage of each provider. For details, see `Placement - API `__. + Tracks the inventory and usage of each provider. For details, see + :doc:`/user/placement`. ``nova-scheduler`` service Takes a virtual machine instance request from the queue and determines on diff --git a/doc/source/user/upgrade.rst b/doc/source/user/upgrade.rst index 45dcf1c47698..e10f54732907 100644 --- a/doc/source/user/upgrade.rst +++ b/doc/source/user/upgrade.rst @@ -29,6 +29,7 @@ This document is trying to describe how we can achieve that. Once we have introduced the key concepts relating to upgrade, we will introduce the process needed for a no downtime upgrade of nova. +.. _minimal_downtime_upgrade: Minimal Downtime Upgrade Process -------------------------------- diff --git a/etc/nova/README-nova.conf.txt b/etc/nova/README-nova.conf.txt index f574b2a63ff9..9e9523f21905 100644 --- a/etc/nova/README-nova.conf.txt +++ b/etc/nova/README-nova.conf.txt @@ -5,4 +5,4 @@ level of the nova directory: For a pre-generated example of the latest nova.conf, see: - http://docs.openstack.org/developer/nova/sample_config.html + https://docs.openstack.org/nova/latest/configuration/sample-config.html diff --git a/nova/cmd/status.py b/nova/cmd/status.py index 34bae85d4a84..0ffd4a757416 100644 --- a/nova/cmd/status.py +++ b/nova/cmd/status.py @@ -45,7 +45,8 @@ from nova import version CONF = nova.conf.CONF -PLACEMENT_DOCS_LINK = 'http://docs.openstack.org/developer/nova/placement.html' +PLACEMENT_DOCS_LINK = 'https://docs.openstack.org/nova/latest' \ + '/user/placement.html' class UpgradeCheckCode(enum.IntEnum): diff --git a/nova/conf/notifications.py b/nova/conf/notifications.py index f42631b37bf1..95e0d29ccc71 100644 --- a/nova/conf/notifications.py +++ b/nova/conf/notifications.py @@ -23,7 +23,7 @@ notifications_group = cfg.OptGroup( Most of the actions in Nova which manipulate the system state generate notifications which are posted to the messaging component (e.g. RabbitMQ) and can be consumed by any service outside the Openstack. More technical details -at http://docs.openstack.org/developer/nova/notifications.html +at https://docs.openstack.org/nova/latest/reference/notifications.html """) ALL_OPTS = [ @@ -108,7 +108,7 @@ Possible values: emitted. (Default) The list of versioned notifications is visible in -http://docs.openstack.org/developer/nova/notifications.html +https://docs.openstack.org/nova/latest/reference/notifications.html """), cfg.ListOpt( 'versioned_notifications_topics', @@ -123,7 +123,7 @@ Nova will send a message containing a versioned notification payload to each topic queue in this list. The list of versioned notifications is visible in -http://docs.openstack.org/developer/nova/notifications.html +https://docs.openstack.org/nova/latest/reference/notifications.html """), cfg.BoolOpt( 'bdms_in_notifications', diff --git a/nova/conf/scheduler.py b/nova/conf/scheduler.py index ecd1716f74b4..d11067def31d 100644 --- a/nova/conf/scheduler.py +++ b/nova/conf/scheduler.py @@ -444,7 +444,7 @@ PCI devices on the host and the number of PCI devices requested by the instance. The ``NUMATopologyFilter`` filter must be enabled for this to have any significance. For more information, refer to the filter documentation: - https://docs.openstack.org/developer/nova/filter_scheduler.html + https://docs.openstack.org/nova/latest/user/filter-scheduler.html Possible values: diff --git a/nova/virt/libvirt/driver.py b/nova/virt/libvirt/driver.py index 96bb1bbe60ec..f408e160c8b8 100644 --- a/nova/virt/libvirt/driver.py +++ b/nova/virt/libvirt/driver.py @@ -438,8 +438,8 @@ class LibvirtDriver(driver.ComputeDriver): LOG.warning('The libvirt driver is not tested on ' '%(type)s/%(arch)s by the OpenStack project and ' 'thus its quality can not be ensured. For more ' - 'information, see: http://docs.openstack.org/' - 'developer/nova/support-matrix.html', + 'information, see: https://docs.openstack.org/' + 'nova/latest/user/support-matrix.html', {'type': CONF.libvirt.virt_type, 'arch': hostarch}) def _handle_conn_event(self, enabled, reason): diff --git a/placement-api-ref/source/index.rst b/placement-api-ref/source/index.rst index a4e7890693f8..c76696e86314 100644 --- a/placement-api-ref/source/index.rst +++ b/placement-api-ref/source/index.rst @@ -6,7 +6,7 @@ This is a reference for the Openstack Placement API. To learn more about Openstack Placement API concepts, please refer to the -`Placement Introduction `_. +`Placement Introduction `_. .. rest_expand_all::