From 3e55e7760905dcc9a3c583744b49db40721c103e Mon Sep 17 00:00:00 2001 From: Eric Fried Date: Fri, 3 Nov 2017 08:58:10 -0500 Subject: [PATCH] Update contributor microversion doc for compute In the microversion contributor doc, refresh the checklist for creating a new microversion. - Remove reference to "doc team" - Add bullet about release note - Add bullet for updating the API reference Change-Id: I81a8cd68792f06738ee9709d07d557a37367a806 --- doc/source/contributor/microversions.rst | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/doc/source/contributor/microversions.rst b/doc/source/contributor/microversions.rst index c253c1c3c265..41c4c09316f6 100644 --- a/doc/source/contributor/microversions.rst +++ b/doc/source/contributor/microversions.rst @@ -342,9 +342,10 @@ necessary to add changes to other places which describe your change: ``nova/api/openstack/api_version_request.py`` * Add a verbose description to - ``nova/api/openstack/compute/rest_api_version_history.rst``. There should - be enough information that it could be used by the docs team for - release notes. + ``nova/api/openstack/compute/rest_api_version_history.rst``. + +* Add a `release note`_ with a ``features`` section announcing the new or + changed feature and the microversion. * Update the expected versions in affected tests, for example in ``nova/tests/unit/api/openstack/compute/test_versions.py``. @@ -359,6 +360,12 @@ necessary to add changes to other places which describe your change: * If the microversion changes the response schema, a new schema and test for the microversion must be added to Tempest. +* Update the `API Reference`_ documentation as appropriate. The source is + located under `api-ref/source/`. + +.. _release note: https://docs.openstack.org/nova/latest/contributor/releasenotes.html +.. _API Reference: https://developer.openstack.org/api-ref/compute/ + Allocating a microversion -------------------------