Skip to content

Commit

Permalink
docs: add references for openedx-events
Browse files Browse the repository at this point in the history
  • Loading branch information
mariajgrimaldi committed Mar 27, 2023
1 parent 758060c commit 9c5f6fe
Show file tree
Hide file tree
Showing 4 changed files with 41 additions and 0 deletions.
17 changes: 17 additions & 0 deletions docs/reference/achitecture-subdomains.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
Architecture Subdomains
=======================

Here we list useful information about Open edX architecture subdomains and
their use in the Hooks Extension framework:

- `Events Naming and Versioning`_
- `Notes on events design and subdomains`_
- `edX Domain Driven Design documentation`_
- `Subdomains from OEP-41`_
- `Message Content Data Guidelines`_

.. _Events Naming and Versioning: https://github.com/openedx/openedx-events/blob/main/docs/decisions/0002-events-naming-and-versioning.rst#L1
.. _edX Domain Driven Design documentation: https://openedx.atlassian.net/wiki/spaces/AC/pages/213910332/Domain-Driven+Design
.. _`Subdomain from OEP-41`: https://docs.openedx.org/projects/openedx-proposals/en/latest/architectural-decisions/oep-0041-arch-async-server-event-messaging.html#subdomain-from-domain-driven-design
.. _`Message Content Data Guidelines`: https://docs.openedx.org/projects/openedx-proposals/en/latest/architectural-decisions/oep-0041-arch-async-server-event-messaging.html?highlight=subdomain#message-content-data-guidelines
.. _`Notes on events design and subdomains`: https://github.com/openedx/openedx-events/issues/72#issuecomment-1179291340
7 changes: 7 additions & 0 deletions docs/reference/index.rst
Original file line number Diff line number Diff line change
@@ -1,2 +1,9 @@
References
##########

.. toctree::
:maxdepth: 1
:caption: Contents:

oeps
architecture-subdomains
Empty file removed docs/reference/oep-51.rst
Empty file.
17 changes: 17 additions & 0 deletions docs/reference/oeps.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
Open edX Proposals
==================

Here we list the Open edX proposals used throughout the project, that will help
you understand the major decisions made during the library's design.

- The `Hooks extension framework (OEP-50)`_ which specifies its motivation,
implementation details, rationale, performance considerations, general use
cases and more. The goal of the OEP-50 is give the extensions' developer a
glance on the framework implementation and design.

- The `Asynchronous Server Event Message Format (OEP-41)`_, which
specifies the header information format sent by the events. For a detailed description
on the impact of the OEP-41, please refer to the Events Payload ADR.

.. _Hooks extension framework (OEP-50): https://open-edx-proposals.readthedocs.io/en/latest/architectural-decisions/oep-0050-hooks-extension-framework.html
.. _Asynchronous Server Event Message Format (OEP-41): https://open-edx-proposals.readthedocs.io/en/latest/architectural-decisions/oep-0041-arch-async-server-event-messaging.html

0 comments on commit 9c5f6fe

Please sign in to comment.