docs: add diagram for illustrating how events work

openedx · Nov 18, 2024 · 02b1e09 · 02b1e09
1 parent 2ed1f05
commit 02b1e09
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/docs/_images/openedx-events-workflow.png b/docs/_images/openedx-events-workflow.png
diff --git 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: