openstack/nova
Code Issues Proposed changes

doc: link to versioned notification samples from main index

Browse Source 
Notifications are essentially another API for end users, but
it can be hard to find the list of existing notifications or
their samples which are buried deep down via contributors >
technical reference deep dive > notitfications. If I'm an
end user, I'd like to just see them in the same set of links
on the main page as the API, under the "For End Users" section.

Change-Id: If3ca21b080d06a291ed27c9bcd84a566164c3b70
This commit is contained in:
Matt Riedemann 2017-09-01 10:42:35 -04:00
parent 33a1799b1d
commit beac1529fd
2 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/source/index.rst
View File

@ -95,6 +95,11 @@ resources will help you get started with consuming the API directly.
parts to understand is the Block Device Mapping parameters used to connect
specific block devices to computes. This deserves its own deep dive.
Nova can be configured to emit notifications over RPC.
* :ref:`Versioned Notifications <versioned_notification_samples>`: This
provides the list of existing versioned notifications with sample payloads.
For Operators
=============

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

@ -311,6 +311,9 @@ requires the notification.
Existing versioned notifications
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. This is a reference anchor used in the main index page.
.. _versioned_notification_samples:
.. versioned_notifications::