diff --git a/docs/_images/openedx-events-workflow.png b/docs/_images/openedx-events-workflow.png new file mode 100644 index 00000000..c8974700 Binary files /dev/null and b/docs/_images/openedx-events-workflow.png differ diff --git a/docs/concepts/openedx-events.rst b/docs/concepts/openedx-events.rst index aca14dce..f9fbe0c1 100644 --- a/docs/concepts/openedx-events.rst +++ b/docs/concepts/openedx-events.rst @@ -20,7 +20,11 @@ Events are primarily used as a communication method between components within th How do Open edX Events work? ---------------------------- -Open edX Events are implemented by a class called `OpenEdxPublicSignal`_, which inherits from `Django's Signals class` and adds behaviors specific to the Open edX ecosystem. Thanks to this design, ``OpenEdxPublicSignal`` leverages the functionality of Django signals, allowing developers to apply their existing knowledge of the Django framework. +Open edX Events are implemented by a class called `OpenEdxPublicSignal`_, which inherits from `Django's Signals class` and adds behaviors specific to the Open edX ecosystem. Thanks to this design, ``OpenEdxPublicSignal`` leverages the functionality of Django signals, allowing developers to apply their existing knowledge of the Django framework. In this diagram, we illustrate the workflow of sending an Open edX Event: + +.. image:: ../_images/openedx-events-workflow.png + :alt: Open edX Events workflow + :align: center The event execution process follows these steps: