From fe4a84fcbf2fe01f387e3163990013ae784304e9 Mon Sep 17 00:00:00 2001 From: Maria Grimaldi Date: Mon, 2 Dec 2024 15:06:16 +0100 Subject: [PATCH] refactor: drop references to confluence event bus page --- docs/concepts/openedx-events.rst | 3 +-- docs/reference/real-life-use-cases.rst | 3 +-- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/docs/concepts/openedx-events.rst b/docs/concepts/openedx-events.rst index 99bef0f35..d186d738b 100644 --- a/docs/concepts/openedx-events.rst +++ b/docs/concepts/openedx-events.rst @@ -15,7 +15,7 @@ These events are built on top of Django signals, inheriting their behavior while Django includes a "signal dispatcher" which helps decoupled applications get notified when actions occur elsewhere in the framework. In a nutshell, signals allow certain senders to notify a set of receivers that some action has taken place. They’re especially useful when many pieces of code may be interested in the same events. -Events are primarily used as a communication method between components within the same application process or with external services using the `Event Bus technology`_, making them the standard communication mechanism within the Open edX ecosystem. +Events are primarily used as a communication method between components within the same application process or with external services using the :doc:`../concepts/event-bus`, making them the standard communication mechanism within the Open edX ecosystem. How do Open edX Events work? ---------------------------- @@ -80,7 +80,6 @@ For more information on using Open edX Events, refer to the :doc:`../how-tos/usi .. _Django Signals Documentation: https://docs.djangoproject.com/en/4.2/topics/signals/ .. _triggering the COURSE_ENROLLMENT_CREATED event: https://github.com/openedx/edx-platform/blob/master/common/djangoapps/student/models/course_enrollment.py#L777-L795 .. _course_enrollment_post_save receiver: https://github.com/openedx/edx-platform/blob/master/openedx/core/djangoapps/notifications/handlers.py#L38-L53 -.. _Event Bus technology: https://openedx.atlassian.net/wiki/spaces/AC/pages/3508699151/How+to+start+using+the+Event+Bus .. _Django signals registry mechanism: https://docs.djangoproject.com/en/4.2/topics/signals/#listening-to-signals .. _signal receivers in their plugins: https://edx.readthedocs.io/projects/edx-django-utils/en/latest/edx_django_utils.plugins.html#edx_django_utils.plugins.constants.PluginSignals .. _Open edX Django plugins: https://edx.readthedocs.io/projects/edx-django-utils/en/latest/plugins/readme.html diff --git a/docs/reference/real-life-use-cases.rst b/docs/reference/real-life-use-cases.rst index 5da283b68..10eeebb73 100644 --- a/docs/reference/real-life-use-cases.rst +++ b/docs/reference/real-life-use-cases.rst @@ -16,7 +16,7 @@ The following list of real-life use cases showcases the different ways Open edX Cross-services communication **************************** -As mentioned in :doc:`../concepts/event-bus`, the suggested strategy for cross-service communication in the Open edX ecosystem is through an event-based architecture implemented via the Event Bus. This functionality used for asynchronous communication between services is built on top of sending Open edX Events (Open edX-specific Django signals) within a service. For more details on the Event Bus, please see :doc:`../how-tos/using-the-event-bus`. +As mentioned in :doc:`../concepts/event-bus`, the suggested strategy for cross-service communication in the Open edX ecosystem is through an event-based architecture implemented via the :doc:`../concepts/event-bus`. This functionality used for asynchronous communication between services is built on top of sending Open edX Events (Open edX-specific Django signals) within a service. For more details on the Event Bus, please see :doc:`../how-tos/using-the-event-bus`. Here are some examples of how the Event Bus can be used to facilitate communication between IDAs: @@ -130,7 +130,6 @@ Here are some additional use cases that can be implemented using Open edX Events .. note:: If you have implemented a solution using Open edX Events and would like to share it with the community, please submit a pull request to add it to this list! -.. _How to Start Using the Event Bus: https://openedx.atlassian.net/wiki/spaces/AC/pages/3508699151/How+to+start+using+the+Event+Bus .. _edx-exams: https://github.com/edx/edx-exams .. _edx-proctoring: https://github.com/openedx/edx-proctoring .. _ADR Implementation of Event Driven Architecture for Exam Downstream Effects: https://github.com/edx/edx-exams/blob/main/docs/decisions/0004-downstream-effect-events.rst