diff --git a/oeps/architectural-decisions/oep-0041-arch-async-server-event-messaging.rst b/oeps/architectural-decisions/oep-0041-arch-async-server-event-messaging.rst index 76ccd66f..d1c787fe 100644 --- a/oeps/architectural-decisions/oep-0041-arch-async-server-event-messaging.rst +++ b/oeps/architectural-decisions/oep-0041-arch-async-server-event-messaging.rst @@ -475,10 +475,14 @@ Having a clearly defined set of events would allow for simpler third party integration in areas like student learner event processing and course catalog management. +.. note:: All decisions related to Open edX Events will now be documented and made publicly available through the Architectural Decision Records (ADRs) in the repository. For more details, refer to the :doc:`Open edX Events ADRs `. + ************** Change History ************** +2024-01-14: Added note about decisions related to Open edX Events being documented and made publicly available through the Architectural Decision Records (ADRs) in the repository. + 2022-01-09: Clarified that time field could be based on updated_at time when appropriate. 2022-03-24: Enhance "Architectural Goals" section and minor edits. diff --git a/oeps/architectural-decisions/oep-0050-hooks-extension-framework.rst b/oeps/architectural-decisions/oep-0050-hooks-extension-framework.rst index 2847e709..284c5826 100644 --- a/oeps/architectural-decisions/oep-0050-hooks-extension-framework.rst +++ b/oeps/architectural-decisions/oep-0050-hooks-extension-framework.rst @@ -263,9 +263,14 @@ The current documentation for the Hooks Extension Framework can be found at `Ope .. _Open edX Guides Hooks: https://github.com/openedx/edx-platform/tree/master/docs/guides/hooks +.. note:: All decisions related to Open edX Events and Filters will now be documented and made publicly available through their respective Architectural Decision Records (ADRs). For more information, see the :doc:`Open edX Events ADRs ` and :doc:`Open edX Filters ADRs `. + Change History ************** +14 January 2025 - Maria Grimaldi +Added note about decisions related to Open edX Events and Filters being documented and made publicly available through the Architectural Decision Records (ADRs) in the repository. + 20 July 2022 - Maria Grimaldi Update OEP-50 with latest documentation. diff --git a/oeps/architectural-decisions/oep-0052-arch-event-bus-architecture.rst b/oeps/architectural-decisions/oep-0052-arch-event-bus-architecture.rst index 7ddfeab1..96502a0a 100644 --- a/oeps/architectural-decisions/oep-0052-arch-event-bus-architecture.rst +++ b/oeps/architectural-decisions/oep-0052-arch-event-bus-architecture.rst @@ -105,9 +105,16 @@ Consequences * Although external events offer many benefits, it also requires a different mindset around eventual consistency. Proper education and experience will be needed to support the success of the event bus. +.. note:: All decisions related to Open edX Events will now be documented and made publicly available through the Architectural Decision Records (ADRs) in the repository. For more details, refer to the :doc:`Open edX Events ADRs `. + Change History ************** +2025-01-14 +========== + +* Added note about decisions related to Open edX Events being documented and made publicly available through the Architectural Decision Records (ADRs) in the repository. + 2024-07-09 ========== diff --git a/oeps/conf.py b/oeps/conf.py index b467bd6b..e3575135 100644 --- a/oeps/conf.py +++ b/oeps/conf.py @@ -360,6 +360,14 @@ f"https://docs.openedx.org/{rtd_language}/{rtd_version}", None, ), + "openedx-events": ( + f"https://docs.openedx.org/projects/openedx-events/{rtd_language}/latest", + None, + ), + "openedx-filters": ( + f"https://docs.openedx.org/projects/openedx-filters/{rtd_language}/latest", + None, + ), } # -- Read the Docs Specific Configuration