From beac1529fdb92dbf17994f785d058fd5b413c588 Mon Sep 17 00:00:00 2001 From: Matt Riedemann Date: Fri, 1 Sep 2017 10:42:35 -0400 Subject: [PATCH] doc: link to versioned notification samples from main index 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 --- doc/source/index.rst | 5 +++++ doc/source/reference/notifications.rst | 3 +++ 2 files changed, 8 insertions(+) diff --git a/doc/source/index.rst b/doc/source/index.rst index 8fd62912e3..3be81ad02f 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -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 `: This + provides the list of existing versioned notifications with sample payloads. + For Operators ============= diff --git a/doc/source/reference/notifications.rst b/doc/source/reference/notifications.rst index 032fd9711f..c76ed36e17 100644 --- a/doc/source/reference/notifications.rst +++ b/doc/source/reference/notifications.rst @@ -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::