diff --git a/README.rst b/README.rst index 1c27ebb70..e087bf5fc 100644 --- a/README.rst +++ b/README.rst @@ -23,7 +23,7 @@ API To learn how to use Placement's API, consult the documentation available online at: -- `Placement API Reference `__ +- `Placement API Reference `__ For more information on OpenStack APIs, SDKs and CLIs in general, refer to: diff --git a/api-ref/source/request-ids.inc b/api-ref/source/request-ids.inc index 751f2c60f..1dfb71afb 100644 --- a/api-ref/source/request-ids.inc +++ b/api-ref/source/request-ids.inc @@ -19,7 +19,7 @@ Even if specifying a global request ID in a request, users receive always a local request ID as the response. For more details about request IDs, please reference: `Faults -`_ +`_ (It is *not* for Placement APIs, but there are some common points.) **Request** diff --git a/api-ref/source/root.inc b/api-ref/source/root.inc index 144adfd82..6864c03f1 100644 --- a/api-ref/source/root.inc +++ b/api-ref/source/root.inc @@ -11,7 +11,7 @@ request microversion 1.10, specify the header:: For more details about Microversions, please reference: `Microversions -`_ +`_ .. note:: The maximum microversion supported by each release varies. Please reference: diff --git a/doc/README.rst b/doc/README.rst index 8c26ea336..a3f627923 100644 --- a/doc/README.rst +++ b/doc/README.rst @@ -7,4 +7,4 @@ https://docs.openstack.org/placement/latest/ Note that the Placement API reference is maintained under the ``/api-ref`` directory and built to: -https://developer.openstack.org/api-ref/placement/ +https://docs.openstack.org/api-ref/placement/ diff --git a/doc/source/contributor/api-ref-guideline.rst b/doc/source/contributor/api-ref-guideline.rst index 09c9f3db8..a6233d525 100644 --- a/doc/source/contributor/api-ref-guideline.rst +++ b/doc/source/contributor/api-ref-guideline.rst @@ -9,7 +9,7 @@ This page describes the guideline for updating the API reference. API reference ============= -* `Placement API reference `_ +* `Placement API reference `_ The guideline to write the API reference ======================================== diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst index 79e56ca02..a53a5db8e 100644 --- a/doc/source/contributor/contributing.rst +++ b/doc/source/contributor/contributing.rst @@ -320,7 +320,7 @@ If there have been no changes, core reviewers should feel free to fast-approve .. _How to Review Changes the OpenStack Way: https://docs.openstack.org/project-team-guide/review-the-openstack-way.html .. _core reviewers: https://review.opendev.org/#/admin/groups/1936,members .. _constructive: https://governance.openstack.org/tc/reference/principles.html#we-value-constructive-peer-review -.. _API: https://developer.openstack.org/api-ref/placement/ +.. _API: https://docs.openstack.org/api-ref/placement/ .. _placement code: https://opendev.org/openstack/placement .. _stein schedule: https://releases.openstack.org/stein/schedule.html .. _release note: https://docs.openstack.org/reno/latest/ diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst index e0ffc557e..aa071841b 100644 --- a/doc/source/contributor/index.rst +++ b/doc/source/contributor/index.rst @@ -250,7 +250,7 @@ because it is composed from queries against many different database entities, presents a mixture of result types (allocation requests and provider summaries), and has a view of the system that is only meaningful *now*. -__ https://developer.openstack.org/api-ref/placement/#list-allocation-candidates +__ https://docs.openstack.org/api-ref/placement/#list-allocation-candidates If a ``Last-Modified`` header is set, then a ``Cache-Control`` header with a value of ``no-cache`` must be set as well. This is to avoid user-agents @@ -379,7 +379,7 @@ information. .. _Response: http://docs.webob.org/en/latest/#response .. _microversions: http://specs.openstack.org/openstack/api-wg/guidelines/microversion_specification.html .. _errors: http://specs.openstack.org/openstack/api-wg/guidelines/errors.html -.. _API Reference: https://developer.openstack.org/api-ref/placement/ +.. _API Reference: https://docs.openstack.org/api-ref/placement/ .. _Placement API Error Handling: http://specs.openstack.org/openstack/nova-specs/specs/rocky/approved/placement-api-error-handling.html .. _`Alembic tutorial`: https://alembic.zzzcomputing.com/en/latest/tutorial.html .. _`autogenerate limitations`: https://alembic.zzzcomputing.com/en/latest/autogenerate.html#what-does-autogenerate-detect-and-what-does-it-not-detect diff --git a/doc/source/index.rst b/doc/source/index.rst index 221b5b196..3a2913d59 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -269,7 +269,7 @@ suitable. There is a plugin to the openstackclient_ command line tool called osc-placement_ which is useful for occasional inspection and manipulation of the resources in the placement service. -.. _HTTP API: https://developer.openstack.org/api-ref/placement/ +.. _HTTP API: https://docs.openstack.org/api-ref/placement/ .. _openstackclient: https://pypi.org/project/openstackclient/ .. _osc-placement: https://pypi.org/project/osc-placement/ diff --git a/doc/source/install/index.rst b/doc/source/install/index.rst index c29ea0e5e..a59a76b2b 100644 --- a/doc/source/install/index.rst +++ b/doc/source/install/index.rst @@ -28,4 +28,4 @@ placement with the rest of an OpenStack cloud. install-ubuntu.rst verify.rst -.. _HTTP API: https://developer.openstack.org/api-ref/placement/ +.. _HTTP API: https://docs.openstack.org/api-ref/placement/ diff --git a/doc/source/usage/index.rst b/doc/source/usage/index.rst index 332b54cac..34f0dcbbf 100644 --- a/doc/source/usage/index.rst +++ b/doc/source/usage/index.rst @@ -61,9 +61,9 @@ portion of the inventory set by the resource tracker. provider-tree -.. _HTTP API: https://developer.openstack.org/api-ref/placement/ -.. _creating the resource provider: https://developer.openstack.org/api-ref/placement/?expanded=create-resource-provider-detail#create-resource-provider -.. _setting the inventory: https://developer.openstack.org/api-ref/placement/?expanded=update-resource-provider-inventories-detail#update-resource-provider-inventories -.. _setting the traits: https://developer.openstack.org/api-ref/placement/?expanded=update-resource-provider-traits-detail#update-resource-provider-traits -.. _allocation candidates: https://developer.openstack.org/api-ref/placement/?expanded=list-allocation-candidates-detail#list-allocation-candidates -.. _allocation: https://developer.openstack.org/api-ref/placement/?expanded=update-allocations-detail#update-allocations +.. _HTTP API: https://docs.openstack.org/api-ref/placement/ +.. _creating the resource provider: https://docs.openstack.org/api-ref/placement/?expanded=create-resource-provider-detail#create-resource-provider +.. _setting the inventory: https://docs.openstack.org/api-ref/placement/?expanded=update-resource-provider-inventories-detail#update-resource-provider-inventories +.. _setting the traits: https://docs.openstack.org/api-ref/placement/?expanded=update-resource-provider-traits-detail#update-resource-provider-traits +.. _allocation candidates: https://docs.openstack.org/api-ref/placement/?expanded=list-allocation-candidates-detail#list-allocation-candidates +.. _allocation: https://docs.openstack.org/api-ref/placement/?expanded=update-allocations-detail#update-allocations diff --git a/doc/source/usage/provider-tree.rst b/doc/source/usage/provider-tree.rst index 35b7f0a7b..b24f6572d 100644 --- a/doc/source/usage/provider-tree.rst +++ b/doc/source/usage/provider-tree.rst @@ -579,9 +579,9 @@ The ``same_subtree`` query parameter can be repeated and each repeat group is treated independently. .. _`Nested Resource Providers`: https://specs.openstack.org/openstack/nova-specs/specs/queens/approved/nested-resource-providers.html -.. _`POST /resource_providers`: https://developer.openstack.org/api-ref/placement/ -.. _`PUT /resource_providers/{uuid}`: https://developer.openstack.org/api-ref/placement/ -.. _`GET /allocation_candidates`: https://developer.openstack.org/api-ref/placement/ +.. _`POST /resource_providers`: https://docs.openstack.org/api-ref/placement/ +.. _`PUT /resource_providers/{uuid}`: https://docs.openstack.org/api-ref/placement/ +.. _`GET /allocation_candidates`: https://docs.openstack.org/api-ref/placement/ .. _`Filtering by Aggregate Membership`: https://specs.openstack.org/openstack/nova-specs/specs/rocky/implemented/alloc-candidates-member-of.html .. _`The Traits API`: http://specs.openstack.org/openstack/nova-specs/specs/pike/implemented/resource-provider-traits.html .. _`Request Traits`: https://specs.openstack.org/openstack/nova-specs/specs/queens/implemented/request-traits-in-nova.html diff --git a/tox.ini b/tox.ini index 4d9da59da..fa615c540 100644 --- a/tox.ini +++ b/tox.ini @@ -119,7 +119,7 @@ commands = [testenv:api-ref] description = - Generate the API ref. Called from CI scripts to test and publish to developer.openstack.org. + Generate the API ref. Called from CI scripts to test and publish to docs.openstack.org. envdir = {toxworkdir}/docs deps = {[testenv:docs]deps} commands =