From 33a1799b1d4452ceb7c86b244192fb9ce478b69a Mon Sep 17 00:00:00 2001 From: Matt Riedemann Date: Tue, 29 Aug 2017 18:48:42 -0400 Subject: [PATCH] doc: link to placement api-ref and history docs from main index Now that we have a placement api-ref getting published, we should link to it like we do for the compute api-ref. This also links in the placement microversion history for consistency. Change-Id: Id0c70486c5a72a4d6794d80d350a45a5f356ca37 --- doc/source/index.rst | 16 ++++++++++++---- doc/source/user/placement.rst | 2 ++ 2 files changed, 14 insertions(+), 4 deletions(-) diff --git a/doc/source/index.rst b/doc/source/index.rst index 16fd337e8c85..8fd62912e36c 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -76,13 +76,21 @@ resources will help you get started with consuming the API directly. concept guide for the API. This helps lay out the concepts behind the API to make consuming the API reference easier. * `Compute API Reference `_: - The complete reference for the API, including all methods and request / - response parameters and their meaning. -* :doc:`API Microversion History `: The - compute API evolves over time through `Microversions + The complete reference for the compute API, including all methods and + request / response parameters and their meaning. +* :doc:`Compute API Microversion History `: + The compute API evolves over time through `Microversions `_. This provides the history of all those changes. Consider it a "what's new" in the compute API. +* `Placement API Reference `_: + The complete reference for the placement API, including all methods and + request / response parameters and their meaning. +* :ref:`Placement API Microversion History `: + The placement API evolves over time through `Microversions + `_. This + provides the history of all those changes. Consider it a "what's new" in the + placement API. * :doc:`Block Device Mapping `: One of the trickier parts to understand is the Block Device Mapping parameters used to connect specific block devices to computes. This deserves its own deep dive. diff --git a/doc/source/user/placement.rst b/doc/source/user/placement.rst index 21f327579da4..18d7bdb6eee7 100644 --- a/doc/source/user/placement.rst +++ b/doc/source/user/placement.rst @@ -245,4 +245,6 @@ nova-compute service could be Newton level code making requests to an Ocata placement API, and vice-versa, an Ocata compute service in a cells v2 cell could be making requests to a Newton placement API. +.. _placement-api-microversion-history: + .. include:: ../../../nova/api/openstack/placement/rest_api_version_history.rst