Skip to content

chore: Update Events and Filters crossreferences to use :ref: rather than :doc: #717

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

chore: Update Events and Filters crossreferences to use :ref: rather than :doc: #717

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1b9bc01
chore: Update Events and Filters crossreferences to use `:ref:` rathe…
sarina Jun 9, 2025
e57f542
chore: Add needed cross-references for filters docs
sarina Jun 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion oeps/architectural-decisions/oep-0041-arch-async-server-event-messaging.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -241,6 +241,8 @@ all Open edX installs. Events that are strictly edX-specific, like those that
might interact with internal IT or finance reporting systems, should use
``org.edx`` as the prefix instead. If in doubt, default to ``org.openedx``.

.. _Subdomain from DDD:

Subdomain (from Domain Driven Design)
-------------------------------------

Expand Down Expand Up @@ -330,6 +332,8 @@ describing the same occurrence (e.g. a version 1 and version 2 of an event), the
should have the *exact* same timestamp.


.. _Message Content Data Guidelines:

Message Content Data Guidelines
===============================

Expand Down Expand Up @@ -477,7 +481,7 @@ management.

------------

.. note:: All future decisions related to :doc:`Open edX Events <openedx-events:index>` 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 <openedx-events:decisions/index>`. This includes decisions regarding the Event Bus, schema format, serialization, evolution, and design practices for event-driven architecture.
.. note:: All future decisions related to :ref:`Open edX Events <openedx-events:Open edX Events Docs>` that adhere to these guidelines for asynchronous event messaging will now be documented and made publicly available through the Architectural Decision Records (ADRs) in :ref:`Open edX Events ADRs <openedx-events:ADRs>`. This includes decisions regarding the Event Bus, schema format, serialization, evolution, and design practices for event-driven architecture.

**************
Change History
Expand Down
2 changes: 1 addition & 1 deletion oeps/architectural-decisions/oep-0050-hooks-extension-framework.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -263,7 +263,7 @@ 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 <openedx-events:decisions/index>` and :doc:`Open edX Filters ADRs <openedx-filters:decisions/index>`.
.. 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 :ref:`Open edX Events ADRs <openedx-events:ADRs>` and :ref:`Open edX Filters ADRs <openedx-filters:ADRs>`.

Change History
**************
Expand Down
14 changes: 4 additions & 10 deletions oeps/architectural-decisions/oep-0052-arch-event-bus-architecture.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ Decision

* An abstraction layer will be provided to enable the choice of multiple technologies for implementing an Open edX event bus.

* See `ADR on Multiple Event Types Per Topic`_ to learn more about the requirement of Open edX event bus implementations to support multiple event types per topic.
* See :ref:`ADR on Multiple Event Types Per Topic <openedx-events:ADR-10>` to learn more about the requirement of Open edX event bus implementations to support multiple event types per topic.

* An initial event bus implementation has been implemented using Kafka.

Expand All @@ -83,22 +83,16 @@ Decision

* Event bus events extend the Hooks Extension Framework events, and use an Avro schema to serialize the existing hooks signals.

* See `ADR on External event bus and Django Signal events`_ to learn more about how the ``OpenEdxPublicSignal`` internal used to send the same internal signal-based events across services, and then fire the signal-based events again within consuming services.
* See `ADR on External Event Schema Format`_ and `ADR on Event Schema Serialization and Evolution`_ to learn about how the Avro Schema format is used for serializing external events published to Kafka, and consumed from Kafka. Additionally, learn about tooling to automatically handle the translation from ``OpenEdxPublicSignal`` internal events to Avro Schema formatted events, and back again. Also learn how this explicit schema format can aid in schema evolution.

.. _ADR on Multiple Event Types Per Topic: https://openedx-events.readthedocs.io/en/latest/decisions/0010-multiple-event-types-per-topic.html
* See :ref:`ADR on External event bus and Django Signal events <openedx-events:ADR-4>` to learn more about how the ``OpenEdxPublicSignal`` internal used to send the same internal signal-based events across services, and then fire the signal-based events again within consuming services.
* See :ref:`ADR on External Event Schema Format <openedx-events:ADR-5>` and :ref:`ADR on Event Schema Serialization and Evolution <openedx-events:ADR-6>` to learn about how the Avro Schema format is used for serializing external events published to Kafka, and consumed from Kafka. Additionally, learn about tooling to automatically handle the translation from ``OpenEdxPublicSignal`` internal events to Avro Schema formatted events, and back again. Also learn how this explicit schema format can aid in schema evolution.

.. _ADR on Kafka-Based Event Bus: https://github.com/openedx/event-bus-kafka/blob/main/docs/decisions/0002-kafka-based-event-bus.rst
.. _ADR on Kafka Managed Hosting: https://github.com/openedx/event-bus-kafka/blob/main/docs/decisions/0004-kafka-managed-hosting.rst
.. _ADR on Managing Kafka Consumers: https://github.com/openedx/event-bus-kafka/blob/main/docs/decisions/0003-managing-kafka-consumers.rst

.. _ADR on Redis streams Event Bus: https://github.com/openedx/event-bus-redis/blob/main/docs/decisions/0002-redis-streams-based-event-bus.rst

.. _ADR on External event bus and Django Signal events: https://openedx-events.readthedocs.io/en/latest/decisions/0004-external-event-bus-and-django-signal-events.html
.. _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 `openedx-events <https://github.com/openedx/openedx-events>`_ repository. For more details, refer to the :doc:`Open edX Events ADRs <openedx-events:decisions/index>`.
.. 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 `openedx-events <https://github.com/openedx/openedx-events>`_ repository. For more details, refer to the :ref:`Open edX Events ADRs <openedx-events:ADRs>`.

Consequences
************
Expand Down