openstack
/
nova
Code Issues Proposed changes

Add a note about versioned notification samples being per-release 

The example versioned notifications don't have any indication of
which release they are available in, and since people can link to
the 'latest' docs, like in I51d0deffc4f42ff2722a8d21aa6b8c8008c62723,
it's important to note that the samples in the latest docs might not
be in the version of nova one is actually using, e.g. ocata or pike.

So this adds a note that people should be aware of that before
relying on some versioned notification.

Change-Id: I2f7db424f0938667895b51f45ea60862a32e22c1
This commit is contained in:
Matt Riedemann 2017-11-15 15:40:08 -05:00
parent e86604fb65
commit 94ca0b9023
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/source/reference/notifications.rst
View File

@ -326,6 +326,11 @@ requires the notification.
Existing versioned notifications
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. note:: Versioned notifications are added in each release, so the samples
represented below may not necessarily be in an older version of nova. Ensure
you are looking at the correct version of the documentation for the release
you are using.
.. This is a reference anchor used in the main index page.
.. _versioned_notification_samples: