diff --git a/doc/api-quick-start/source/api-quick-start.rst b/doc/api-quick-start/source/api-quick-start.rst index 1817c065ae..fd3d913a51 100644 --- a/doc/api-quick-start/source/api-quick-start.rst +++ b/doc/api-quick-start/source/api-quick-start.rst @@ -180,7 +180,7 @@ Send API requests This section shows how to make some basic Compute API calls. For a complete list of Compute API calls, see -`Compute API `__. +`Compute API `__. Export the token ID to the ``OS_TOKEN`` environment variable. For example: diff --git a/doc/api-quick-start/source/index.rst b/doc/api-quick-start/source/index.rst index 8e721c5014..58334b6e48 100644 --- a/doc/api-quick-start/source/index.rst +++ b/doc/api-quick-start/source/index.rst @@ -27,7 +27,7 @@ complete other actions in your OpenStack cloud. The notation '(microversions)' next to the link to an API reference indicates that the API follows a `pattern established by the Compute service - `__ + `__ to enable small, documented changes to the API on a resource-by-resource basis. @@ -36,67 +36,67 @@ complete other actions in your OpenStack cloud. Current API versions -------------------- -`Acceleration API v1 `__ +`Acceleration API v1 `__ -`Application Catalog API v1 `__ +`Application Catalog API v1 `__ -`Application Container Service API `__ (microversions) +`Application Container Service API `__ (microversions) -`Backup API v1 `__ +`Backup API v1 `__ -`Bare Metal API v1 `__ (microversions) +`Bare Metal API v1 `__ (microversions) -`Block Storage API v3 `__ (microversions) +`Block Storage API v3 `__ (microversions) .. note:: The Block Storage API v3 is functionally identical to the Block Storage API v2. Subsequent API v3 microversions, such as v3.1, differ from API v2. -`Clustering API v1 `__ +`Clustering API v1 `__ -`Compute API `__ (microversions) +`Compute API `__ (microversions) -`Container Infrastructure Management API `__ (microversions) +`Container Infrastructure Management API `__ (microversions) -`Data Processing v1.1 `__ +`Data Processing v1.1 `__ -`Data Protection Orchestration v1 `__ +`Data Protection Orchestration v1 `__ -`Database Service API v1.0 `__ +`Database Service API v1.0 `__ -`Domain Name Server (DNS) API v2 `__ +`Domain Name Server (DNS) API v2 `__ -`EC2 API Service `__ +`EC2 API Service `__ -`Function Engine `__ +`Function Engine `__ -`Identity API v3 `__ +`Identity API v3 `__ -`Identity API v3 extensions `__ +`Identity API v3 extensions `__ -`Image service API v2 `__ +`Image service API v2 `__ `Key Manager API v1 `__ -`Load Balancer API v2 `__ +`Load Balancer API v2 `__ -`Messaging API v2 `__ +`Messaging API v2 `__ -`Networking API v2.0 `__ +`Networking API v2.0 `__ -`NFV Orchestration API v1.0 `__ +`NFV Orchestration API v1.0 `__ -`Object Storage API v1 `__ +`Object Storage API v1 `__ -`Orchestration API v1 `__ +`Orchestration API v1 `__ -`Placement API `__ (microversions) +`Placement API `__ (microversions) -`Resource Optimization API v1 `__ +`Resource Optimization API v1 `__ -`Search API v1 `__ +`Search API v1 `__ -`Shared File Systems API v2 `__ (microversions) +`Shared File Systems API v2 `__ (microversions) .. 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, @@ -109,13 +109,13 @@ Supported API versions Deprecated API versions ----------------------- -`Block Storage API v2 `__ +`Block Storage API v2 `__ .. note:: The Block Storage API v3 is functionally identical to the Block Storage API v2. Subsequent API v3 microversions, such as v3.1, differ from API v2. -`Identity API v2.0 extensions `__ +`Identity API v2.0 extensions `__ .. todo: telemetry link diff --git a/doc/doc-contrib-guide/source/api-guides.rst b/doc/doc-contrib-guide/source/api-guides.rst index e83733132d..73bf6b8baf 100644 --- a/doc/doc-contrib-guide/source/api-guides.rst +++ b/doc/doc-contrib-guide/source/api-guides.rst @@ -9,7 +9,8 @@ Source files for developer.openstack.org 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 -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 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] # 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 commands = - rm -rf api-ref/build - sphinx-build -W -b html -d api-ref/build/doctrees api-ref/source api-ref/build/html + rm -rf api-ref/build + 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: @@ -170,7 +171,7 @@ The basic steps are: file stored in ``openstack/project-config`` repository. 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 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 +.. _`docs.openstack.org`: https://docs.openstack.org .. _`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/ .. _`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/ .. _`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 diff --git a/doc/doc-contrib-guide/source/doc-tools/scripts.rst b/doc/doc-contrib-guide/source/doc-tools/scripts.rst index 15063f7743..6f04dfcd51 100644 --- a/doc/doc-contrib-guide/source/doc-tools/scripts.rst +++ b/doc/doc-contrib-guide/source/doc-tools/scripts.rst @@ -10,7 +10,7 @@ openstackdocstheme ~~~~~~~~~~~~~~~~~~ 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 branches are created for each release series. diff --git a/releasenotes/source/mitaka.rst b/releasenotes/source/mitaka.rst index 4d4dc9aa1b..37c6fc8eec 100644 --- a/releasenotes/source/mitaka.rst +++ b/releasenotes/source/mitaka.rst @@ -90,9 +90,9 @@ API Guides * New, cleaner `developer.openstack.org `_ landing page. -* `API Quick Start `_ +* `API Quick Start `_ converted to RST with theme styling to match. -* `Compute API Guide `_ +* `Compute API Guide `_ now built from nova source tree. * Built draft swagger files. * Created templates for writing API guides for projects teams available diff --git a/releasenotes/source/newton.rst b/releasenotes/source/newton.rst index 52b3d4dbd6..ae83274e40 100644 --- a/releasenotes/source/newton.rst +++ b/releasenotes/source/newton.rst @@ -41,10 +41,10 @@ API guides * The API reference documentation has been moved from the api-site repository to project specific repositories. The collection of API docs - is now available on the `OpenStack API Documentation `_. + is now available on the `OpenStack API Documentation `_. -* The `Compute API `_ and - `DNS API `__ sites offer great +* The `Compute API `_ and + `DNS API `__ sites offer great examples of the new API reference, maintained by the project team rather than a central docs team.