From 43571e1ae05344fa195e10627cd8de0699b1f98c Mon Sep 17 00:00:00 2001 From: Maria Grimaldi Date: Mon, 4 Nov 2024 14:37:34 +0100 Subject: [PATCH] refactor: use glossary format for glossary --- docs/reference/glossary.rst | 50 +++++++++---------------------------- 1 file changed, 12 insertions(+), 38 deletions(-) diff --git a/docs/reference/glossary.rst b/docs/reference/glossary.rst index e3887f4c..5bdc5bd2 100644 --- a/docs/reference/glossary.rst +++ b/docs/reference/glossary.rst @@ -1,47 +1,21 @@ Open edX Events Glossary ########################## -This glossary provides definitions for some of the terms to ease the adoption -of the Open edX Events library. +An event has multiple components that are used to define, trigger, and handle the event. This glossary provides definitions for some of the terms to ease the adoption of the Open edX Events library. -Event Receiver --------------- +.. glossary:: -An event receiver, handler or listener is a function that listens for a specific -event and executes custom logic in response to the event being triggered. Since -Events are Django-signals, then receivers are registered with the signal -dispatcher and are called when the event is emitted. In Django, event receivers -are known as signal handlers. Both terms are used interchangeably. + Event Receiver + An event receiver, handler or listener is a function that listens for a specific event and executes custom logic in response to the event being triggered. Since Events are Django-signals, then receivers are registered with the signal dispatcher and are called when the event is emitted. In Django, event receivers are known as signal handlers. Both terms are used interchangeably. -Event Trigger -------------- + Event Trigger + An event trigger is the action that causes an event to be emitted. When a trigger action occurs, the associated event is emitted, and any registered event receivers are called to handle the event. -An event trigger is the action that causes an event to be emitted. When a -trigger action occurs, the associated event is emitted, and any registered event -receivers are called to handle the event. + Event Payload + The event payload is the data associated with an event that is passed to event receivers when it's triggered. The payload of an event are data attribute classes (e.g. ``CourseEnrollmentData``, ``UserData``, etc.) that carry data about the event such as the event name, timestamp, and any additional metadata and information about the actual event. For more information, see the `ADR: Events Payload`_. -Event Payload -------------- + Event Type + The event type is a unique identifier for an event that distinguishes it from other events. For example, ``org.openedx.content_authoring.xblock.published.v1``. The event type is used to identify the event, its purpose, and version. In the event-bus context, the event type is used to connect events to the appropriate topics in the ``EVENT_BUS_PRODUCER_CONFIG``. -The event payload is the data associated with an event that is passed to event -receivers when it's triggered. The payload of an event are data attribute classes (e.g. `CourseEnrollmentData`, `UserData`, etc.) -that carry data about the event such as the event name, timestamp, and any additional -metadata and information about the actual event. For more information, see the -`ADR: Events Payload`_. - -Event Type ----------- - -The event type is a unique identifier for an event that distinguishes it from -other events. For example, `org.openedx.content_authoring.xblock.published.v1`. The event type is used to -identify the event, its purpose, and version. In the event-bus context, the event -type is used to connect events to the appropriate topics in the ``EVENT_BUS_PRODUCER_CONFIG``. - -Event Definition ----------------- - -An event definition is the instantiation of the `OpenEdxPublicSignal` class that -defines the structure and metadata of an event. The event definition includes -information such as the event name, description, payload, and version. Event -definitions are used to create events which are later imported into the -application and used to trigger events using the `send_event` method. + Event Definition + An event definition (or simply, event) is the instantiation of the ``OpenEdxPublicSignal`` class that defines the structure and metadata of an event. This definition includes information such as the event name, description, payload, and version. Event definitions are used to create events which are later imported into the services and are triggered by using the ``send_event`` method.