Update api-ref location
The api documentation is now published on docs.openstack.org instead of developer.openstack.org. Update all links that are changed to the new location. Note that redirects will be set up as well but let's point now to the new location. For details, see: http://lists.openstack.org/pipermail/openstack-discuss/2019-July/007828.html Change-Id: Iccddd4356b5d7c28977ad954654d0875972dae97
This commit is contained in:
Andreas Jaeger
parent
9e8040bf0c
commit
7b3c179fe4
|
|
@ -23,7 +23,7 @@ API
|
|||
To learn how to use Placement's API, consult the documentation available
|
||||
online at:
|
||||
|
||||
- `Placement API Reference <https://developer.openstack.org/api-ref/placement/>`__
|
||||
- `Placement API Reference <https://docs.openstack.org/api-ref/placement/>`__
|
||||
|
||||
For more information on OpenStack APIs, SDKs and CLIs in general, refer to:
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
<https://developer.openstack.org/api-guide/compute/faults.html>`_
|
||||
<https://docs.openstack.org/api-guide/compute/faults.html>`_
|
||||
(It is *not* for Placement APIs, but there are some common points.)
|
||||
|
||||
**Request**
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ request microversion 1.10, specify the header::
|
|||
|
||||
For more details about Microversions, please reference:
|
||||
`Microversions
|
||||
<https://developer.openstack.org/api-guide/compute/microversions.html>`_
|
||||
<https://docs.openstack.org/api-guide/compute/microversions.html>`_
|
||||
|
||||
.. note:: The maximum microversion supported by each release varies.
|
||||
Please reference:
|
||||
|
|
|
|||
|
|
@ -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/
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ This page describes the guideline for updating the API reference.
|
|||
API reference
|
||||
=============
|
||||
|
||||
* `Placement API reference <https://developer.openstack.org/api-ref/placement/>`_
|
||||
* `Placement API reference <https://docs.openstack.org/api-ref/placement/>`_
|
||||
|
||||
The guideline to write the API reference
|
||||
========================================
|
||||
|
|
|
|||
|
|
@ -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/
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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/
|
||||
|
||||
|
|
|
|||
|
|
@ -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/
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
2
tox.ini
2
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 =
|
||||
|
|
|
|||
Loading…
Reference in New Issue