From 8e1b831806fc50305f66f6624dd36506eb288a7c Mon Sep 17 00:00:00 2001 From: Maria Grimaldi Date: Tue, 14 Jan 2025 13:14:39 +0100 Subject: [PATCH] docs: add note about decisions documented in each hooks repositories --- .../oep-0041-arch-async-server-event-messaging.rst | 6 ++++++ .../oep-0050-hooks-extension-framework.rst | 5 +++++ .../oep-0052-arch-event-bus-architecture.rst | 7 +++++++ oeps/conf.py | 8 ++++++++ 4 files changed, 26 insertions(+) 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 76ccd66f0..ccb9bc0c3 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,16 @@ 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 future decisions related to :doc:`Open edX Events ` that adhere to these guidelines for asynchronous event messaging will now be documented and made publicly available through the Architectural Decision Records (ADRs) in :doc:`Open edX Events ADRs `. This includes decisions regarding the Event Bus, schema format, serialization, evolution, and design practices for event-driven architecture. + ************** 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 2847e7091..284c5826b 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 7ddfeab1a..d181a26b0 100644 --- a/oeps/architectural-decisions/oep-0052-arch-event-bus-architecture.rst +++ b/oeps/architectural-decisions/oep-0052-arch-event-bus-architecture.rst @@ -96,6 +96,8 @@ Decision .. _ADR on External Event Schema Format: https://openedx-events.readthedocs.io/en/latest/decisions/0005-external-event-schema-format.html .. _ADR on Event Schema Serialization and Evolution: https://openedx-events.readthedocs.io/en/latest/decisions/0006-event-schema-serialization-and-evolution.html +.. note:: All decisions related to Open edX Events where the event bus key components are implemented 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 `. + Consequences ************ @@ -108,6 +110,11 @@ Consequences 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 b467bd6bd..e35751351 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