Skip to content
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.

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

docs: [FC-0074] list filters in corresponding arch subdomain #251

Open
wants to merge 1 commit into
base: MJG/create-a-new-filter
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions docs/reference/architecture-subdomains.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ Here we list useful information about Open edX architecture subdomains and their
- `Subdomains from OEP-41`_
- `Message Content Data Guidelines`_

.. note:: When creating new filters in a new subdomain, please list the subdomain in this document and in :doc:`filters`.

.. _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
.. _`Subdomains 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
Expand Down
9 changes: 9 additions & 0 deletions docs/reference/filters.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,14 @@ This is the list of Open edX Filters found in this repository.
.. note::
Filters can be created in other projects and plugins as well, but these default filters are guaranteed to exist.

Learning Subdomain
------------------

.. automodule:: openedx_filters.learning.filters
:members:

Course Authoring Subdomain
--------------------------

.. automodule:: openedx_filters.course_authoring.filters
:members:
Loading