openstack/nova
Code Issues Proposed changes
a263fa46f8
nova/doc/source/reference/notifications.rst

16 lines
490 B
ReStructuredText
Raw Normal View History

doc: Split up notifications document This was actually three documents in one: - An admin doc detailing how to configure and use notifications - A contributor doc describing how to extend the versioned notifications - A reference doc listing available versioned notifications Split the doc up to reflect this Change-Id: I880f1c77387efcc3c1e147323b224e10156e0a52 Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2021-11-09 14:55:54 +00:00
=================================
Available versioned notifications
=================================
doc: add devref about versioned notifications Partially-Implements: bp versioned-notification-api Change-Id: Iac01b8324b7115864aca75ab0b1335a26259aa56
2016-01-04 13:26:31 +01:00
doc: Split up notifications document This was actually three documents in one: - An admin doc detailing how to configure and use notifications - A contributor doc describing how to extend the versioned notifications - A reference doc listing available versioned notifications Split the doc up to reflect this Change-Id: I880f1c77387efcc3c1e147323b224e10156e0a52 Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2021-11-09 14:55:54 +00:00
.. note::
doc: add devref about versioned notifications Partially-Implements: bp versioned-notification-api Change-Id: Iac01b8324b7115864aca75ab0b1335a26259aa56
2016-01-04 13:26:31 +01:00
doc: Split up notifications document This was actually three documents in one: - An admin doc detailing how to configure and use notifications - A contributor doc describing how to extend the versioned notifications - A reference doc listing available versioned notifications Split the doc up to reflect this Change-Id: I880f1c77387efcc3c1e147323b224e10156e0a52 Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2021-11-09 14:55:54 +00:00
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.
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
2017-11-15 15:40:08 -05:00
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
2017-09-01 10:42:35 -04:00
.. This is a reference anchor used in the main index page.
.. _versioned_notification_samples:
Generate doc for versioned notifications This commit adds a new sphinx extension that inspects the nova code and adds information about the existing versioned notifications to the nofitications devref. This way the devref is automatically kept up to date with relevant information. Partially-Implements: bp versioned-notification-api Change-Id: If65d5d81e26cb2b4a9f57a8c7d37d3de310ebe00
2016-01-08 10:15:33 +01:00
.. versioned_notifications::
Copy Permalink