openstack/openstack-manuals
Code Issues Proposed changes

Update docs for api move

Browse Source 
Most content from developer.openstack.org is now on docs.openstack.org,
update documentation for this.

A few links for the main index page and translated documents are not
updated yet, they will be updated once they are moved.

Change-Id: Ic7ff7a78c8b1e1ac2b2fef2398e700a59f84d779
This commit is contained in:
Andreas Jaeger 2019-07-22 20:34:44 +02:00 committed by Andreas Jaeger
parent 6f0bb482b4
commit 33a29b2ffb
6 changed files with 47 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/api-quick-start/source/api-quick-start.rst
View File

@ -180,7 +180,7 @@ Send API requests
This section shows how to make some basic Compute API calls. For a complete This section shows how to make some basic Compute API calls. For a complete
list of Compute API calls, see list of Compute API calls, see
`Compute API <https://developer.openstack.org/api-ref/compute/>`__. `Compute API <https://docs.openstack.org/api-ref/compute/>`__.
Export the token ID to the ``OS_TOKEN`` environment variable. For example: Export the token ID to the ``OS_TOKEN`` environment variable. For example:

62
doc/api-quick-start/source/index.rst
View File

@ -27,7 +27,7 @@ complete other actions in your OpenStack cloud.
The notation '(microversions)' next to the link to an API reference The notation '(microversions)' next to the link to an API reference
indicates that the API follows a `pattern established by the Compute indicates that the API follows a `pattern established by the Compute
service service
<https://developer.openstack.org/api-guide/compute/microversions.html>`__ <https://docs.openstack.org/api-guide/compute/microversions.html>`__
to enable small, documented changes to the API on a resource-by-resource to enable small, documented changes to the API on a resource-by-resource
basis. basis.
@ -36,67 +36,67 @@ complete other actions in your OpenStack cloud.
Current API versions Current API versions
-------------------- --------------------
`Acceleration API v1 <https://developer.openstack.org/api-ref/accelerator/v1/>`__ `Acceleration API v1 <https://docs.openstack.org/api-ref/accelerator/v1/>`__
`Application Catalog API v1 <https://developer.openstack.org/api-ref/application-catalog/v1/>`__ `Application Catalog API v1 <https://docs.openstack.org/api-ref/application-catalog/v1/>`__
`Application Container Service API <https://developer.openstack.org/api-ref/application-container/>`__ (microversions) `Application Container Service API <https://docs.openstack.org/api-ref/application-container/>`__ (microversions)
`Backup API v1 <https://developer.openstack.org/api-ref/backup/v1/>`__ `Backup API v1 <https://docs.openstack.org/api-ref/backup/v1/>`__
`Bare Metal API v1 <https://developer.openstack.org/api-ref/baremetal/>`__ (microversions) `Bare Metal API v1 <https://docs.openstack.org/api-ref/baremetal/>`__ (microversions)
`Block Storage API v3 <https://developer.openstack.org/api-ref/block-storage/v3/>`__ (microversions) `Block Storage API v3 <https://docs.openstack.org/api-ref/block-storage/v3/>`__ (microversions)
.. note:: The Block Storage API v3 is functionally identical to the .. note:: The Block Storage API v3 is functionally identical to the
Block Storage API v2. Subsequent API v3 microversions, such as v3.1, Block Storage API v2. Subsequent API v3 microversions, such as v3.1,
differ from API v2. differ from API v2.
`Clustering API v1 <https://developer.openstack.org/api-ref/clustering/>`__ `Clustering API v1 <https://docs.openstack.org/api-ref/clustering/>`__
`Compute API <https://developer.openstack.org/api-ref/compute/>`__ (microversions) `Compute API <https://docs.openstack.org/api-ref/compute/>`__ (microversions)
`Container Infrastructure Management API <https://developer.openstack.org/api-ref/container-infrastructure-management/>`__ (microversions) `Container Infrastructure Management API <https://docs.openstack.org/api-ref/container-infrastructure-management/>`__ (microversions)
`Data Processing v1.1 <https://developer.openstack.org/api-ref/data-processing/>`__ `Data Processing v1.1 <https://docs.openstack.org/api-ref/data-processing/>`__
`Data Protection Orchestration v1 <https://developer.openstack.org/api-ref/data-protection-orchestration/>`__ `Data Protection Orchestration v1 <https://docs.openstack.org/api-ref/data-protection-orchestration/>`__
`Database Service API v1.0 <https://developer.openstack.org/api-ref/database/>`__ `Database Service API v1.0 <https://docs.openstack.org/api-ref/database/>`__
`Domain Name Server (DNS) API v2 <https://developer.openstack.org/api-ref/dns/>`__ `Domain Name Server (DNS) API v2 <https://docs.openstack.org/api-ref/dns/>`__
`EC2 API Service <https://developer.openstack.org/api-ref/ec2-api/>`__ `EC2 API Service <https://docs.openstack.org/api-ref/ec2-api/>`__
`Function Engine <https://developer.openstack.org/api-ref/function-engine/>`__ `Function Engine <https://docs.openstack.org/api-ref/function-engine/>`__
`Identity API v3 <https://developer.openstack.org/api-ref/identity/v3>`__ `Identity API v3 <https://docs.openstack.org/api-ref/identity/v3>`__
`Identity API v3 extensions <https://developer.openstack.org/api-ref/identity/v3-ext>`__ `Identity API v3 extensions <https://docs.openstack.org/api-ref/identity/v3-ext>`__
`Image service API v2 <https://developer.openstack.org/api-ref/image/v2>`__ `Image service API v2 <https://docs.openstack.org/api-ref/image/v2>`__
`Key Manager API v1 <https://docs.openstack.org/barbican/latest/api/>`__ `Key Manager API v1 <https://docs.openstack.org/barbican/latest/api/>`__
`Load Balancer API v2 <https://developer.openstack.org/api-ref/load-balancer/v2>`__ `Load Balancer API v2 <https://docs.openstack.org/api-ref/load-balancer/v2>`__
`Messaging API v2 <https://developer.openstack.org/api-ref/message>`__ `Messaging API v2 <https://docs.openstack.org/api-ref/message>`__
`Networking API v2.0 <https://developer.openstack.org/api-ref/network/v2>`__ `Networking API v2.0 <https://docs.openstack.org/api-ref/network/v2>`__
`NFV Orchestration API v1.0 <https://developer.openstack.org/api-ref/nfv-orchestration/v1/>`__ `NFV Orchestration API v1.0 <https://docs.openstack.org/api-ref/nfv-orchestration/v1/>`__
`Object Storage API v1 <https://developer.openstack.org/api-ref/object-store>`__ `Object Storage API v1 <https://docs.openstack.org/api-ref/object-store>`__
`Orchestration API v1 <https://developer.openstack.org/api-ref/orchestration/v1/>`__ `Orchestration API v1 <https://docs.openstack.org/api-ref/orchestration/v1/>`__
`Placement API <https://developer.openstack.org/api-ref/placement/>`__ (microversions) `Placement API <https://docs.openstack.org/api-ref/placement/>`__ (microversions)
`Resource Optimization API v1 <https://developer.openstack.org/api-ref/resource-optimization>`__ `Resource Optimization API v1 <https://docs.openstack.org/api-ref/resource-optimization>`__
`Search API v1 <https://developer.openstack.org/api-ref/search>`__ `Search API v1 <https://docs.openstack.org/api-ref/search>`__
`Shared File Systems API v2 <https://developer.openstack.org/api-ref/shared-file-system>`__ (microversions) `Shared File Systems API v2 <https://docs.openstack.org/api-ref/shared-file-system>`__ (microversions)
.. note:: The Shared File Systems API v1 is functionally identical to the .. note:: The Shared File Systems API v1 is functionally identical to the
Shared File Systems API v2. Subsequent API v2 microversions, such as v2.1, Shared File Systems API v2. Subsequent API v2 microversions, such as v2.1,
@ -109,13 +109,13 @@ Supported API versions
Deprecated API versions Deprecated API versions
----------------------- -----------------------
`Block Storage API v2 <https://developer.openstack.org/api-ref/block-storage/v2/>`__ `Block Storage API v2 <https://docs.openstack.org/api-ref/block-storage/v2/>`__
.. note:: The Block Storage API v3 is functionally identical to the .. note:: The Block Storage API v3 is functionally identical to the
Block Storage API v2. Subsequent API v3 microversions, such as v3.1, Block Storage API v2. Subsequent API v3 microversions, such as v3.1,
differ from API v2. differ from API v2.
`Identity API v2.0 extensions <https://developer.openstack.org/api-ref/identity/v2-ext>`__ `Identity API v2.0 extensions <https://docs.openstack.org/api-ref/identity/v2-ext>`__
.. todo: telemetry link .. todo: telemetry link

16
doc/doc-contrib-guide/source/api-guides.rst
View File

@ -9,7 +9,8 @@ Source files for developer.openstack.org
The `developer.openstack.org`_ web site is intended for application developers The `developer.openstack.org`_ web site is intended for application developers
using the OpenStack APIs to build upon. It contains links to multiple SDKs for using the OpenStack APIs to build upon. It contains links to multiple SDKs for
specific programming languages, API references, and API Guides. specific programming languages. The API references and API Guides are
stored on `docs.openstack.org`_.
For existing APIs, the reference information comes from RST and YAML source For existing APIs, the reference information comes from RST and YAML source
files. The RST and YAML files get stored in your project repository in an files. The RST and YAML files get stored in your project repository in an
@ -153,11 +154,11 @@ The basic steps are:
[testenv:api-ref] [testenv:api-ref]
# This environment is called from CI scripts to test and publish # This environment is called from CI scripts to test and publish
# the API Ref to developer.openstack.org. # the API Ref to docs.openstack.org.
whitelist_externals = rm whitelist_externals = rm
commands = commands =
rm -rf api-ref/build rm -rf api-ref/build
sphinx-build -W -b html -d api-ref/build/doctrees api-ref/source api-ref/build/html sphinx-build -W -b html -d api-ref/build/doctrees api-ref/source api-ref/build/html
#. Test the ``tox.ini`` changes by running this tox command: #. Test the ``tox.ini`` changes by running this tox command:
@ -170,7 +171,7 @@ The basic steps are:
file stored in ``openstack/project-config`` repository. file stored in ``openstack/project-config`` repository.
After the source files and build jobs exist, the docs are built to After the source files and build jobs exist, the docs are built to
`developer.openstack.org`_. `docs.openstack.org`_.
If your document is completely new, you need to add links to it from the API If your document is completely new, you need to add links to it from the API
landing page and the OpenStack Governance reference document, landing page and the OpenStack Governance reference document,
@ -186,11 +187,12 @@ documentation, patch the ``reference/projects.yaml`` file in the
.. _`developer.openstack.org`: https://developer.openstack.org .. _`developer.openstack.org`: https://developer.openstack.org
.. _`docs.openstack.org`: https://docs.openstack.org
.. _`wadl2rst`: https://github.com/annegentle/wadl2rst .. _`wadl2rst`: https://github.com/annegentle/wadl2rst
.. _`Compute API Guide`: https://developer.openstack.org/api-guide/compute .. _`Compute API Guide`: https://docs.openstack.org/api-guide/compute
.. _`example patch`: https://review.opendev.org/#/c/233446/ .. _`example patch`: https://review.opendev.org/#/c/233446/
.. _`API documentation guidelines`: https://specs.openstack.org/openstack/api-wg/guidelines/api-docs.html .. _`API documentation guidelines`: https://specs.openstack.org/openstack/api-wg/guidelines/api-docs.html
.. _`microversions`: https://developer.openstack.org/api-guide/compute/microversions.html .. _`microversions`: https://docs.openstack.org/api-guide/compute/microversions.html
.. _`API Quick Start page`: https://docs.openstack.org/api-quick-start/ .. _`API Quick Start page`: https://docs.openstack.org/api-quick-start/
.. _`cycle-with-milestones release model`: https://releases.openstack.org/reference/release_models.html#cycle-with-milestones .. _`cycle-with-milestones release model`: https://releases.openstack.org/reference/release_models.html#cycle-with-milestones
.. _`nova example`: https://github.com/openstack/nova/blob/master/api-ref/source/conf.py .. _`nova example`: https://github.com/openstack/nova/blob/master/api-ref/source/conf.py

2
doc/doc-contrib-guide/source/doc-tools/scripts.rst
View File

@ -10,7 +10,7 @@ openstackdocstheme
~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~
openstackdocstheme is a theme and extension support for Sphinx documentation openstackdocstheme is a theme and extension support for Sphinx documentation
that is published to docs.openstack.org and developer.openstack.org. It that is published to docs.openstack.org. It
provides an external link helper to automatically build links that change when provides an external link helper to automatically build links that change when
branches are created for each release series. branches are created for each release series.

4
releasenotes/source/mitaka.rst
View File

@ -90,9 +90,9 @@ API Guides
* New, cleaner `developer.openstack.org <https://developer.openstack.org>`_ * New, cleaner `developer.openstack.org <https://developer.openstack.org>`_
landing page. landing page.
* `API Quick Start <https://developer.openstack.org/api-guide/quick-start/>`_ * `API Quick Start <https://docs.openstack.org/api-quick-start/>`_
converted to RST with theme styling to match. converted to RST with theme styling to match.
* `Compute API Guide <https://developer.openstack.org/api-guide/compute/>`_ * `Compute API Guide <https://docs.openstack.org/api-guide/compute/>`_
now built from nova source tree. now built from nova source tree.
* Built draft swagger files. * Built draft swagger files.
* Created templates for writing API guides for projects teams available * Created templates for writing API guides for projects teams available

6
releasenotes/source/newton.rst
View File

@ -41,10 +41,10 @@ API guides
* The API reference documentation has been moved from the api-site * The API reference documentation has been moved from the api-site
repository to project specific repositories. The collection of API docs repository to project specific repositories. The collection of API docs
is now available on the `OpenStack API Documentation <https://developer.openstack.org/api-guide/quick-start/>`_. is now available on the `OpenStack API Documentation <https://docs.openstack.org/api-quick-start/>`_.
* The `Compute API <https://developer.openstack.org/api-ref/compute/>`_ and * The `Compute API <https://docs.openstack.org/api-ref/compute/>`_ and
`DNS API <https://developer.openstack.org/api-ref/dns/>`__ sites offer great `DNS API <https://docs.openstack.org/api-ref/dns/>`__ sites offer great
examples of the new API reference, maintained by the project team rather examples of the new API reference, maintained by the project team rather
than a central docs team. than a central docs team.