Skip to content

feat: update automatic tagging decision #61

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

Merged
pomegranited merged 1 commit into from
Jul 4, 2023
Merged

feat: update automatic tagging decision #61

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
35 changes: 23 additions & 12 deletions docs/decisions/0013-system-taxonomy-auto-tagging.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,23 @@
Context
--------

One main characteristic of system-defined taxonomies is automatic content tagging.
One main characteristic of system-defined taxonomies is automatic content tagging.
It is necessary to implement this functionality when the associated content is created or edited.

Decision
---------

Use `openedx-filters`_ to call the auto tagging function after content creation/edition.

Filters
Events
~~~~~~~~

It is necessary to create `filters`_ for each content for creation/edition: ``CourseCreation``, ``LibraryCreation``, etc.
This filters will live on ``openedx-filters``.
It is necessary to create `events`_ for each content for creation/edition: ``CourseCreation``, ``LibraryCreation``, etc.
This events will live in `openedx-events`_.

Pipelines
Receivers
~~~~~~~~~~

Auto-tagging pipelines will live under ``openedx.features.tagging``,
registered as `a pipeline`_ with the respective filter.
Auto-tagging receivers will live under ``openedx.features.tagging``,
registered as `a receiver`_ with the respective code.

Rejected Options
-----------------
Expand All @@ -31,10 +29,23 @@ Django Signals
~~~~~~~~~~~~~~

Implement a function to add the tag from the content metadata and register that function
as a Django signal. This works for Django database models, but some of the content lives in Mongo,
as a Django signal. This works for Django database models, but some of the content lives in Mongo,
outside of the Django models. Also, using openedx-filters is better in the edx context, but if there is
other no-edX project that need to use ``openedx-tagging``, can use the Django Signals approach.


openedx-filters
~~~~~~~~~~~~~~~
Use `openedx-filters`_ to create a `filter`_ which calls `the auto tagging pipeline`_ after content
creation/editing. Although this approach works, there are more suitable options. Filters are
used to act on the input data and provide means to block the flow. This is not necessary in the
auto tagging context. The `hooks documentation`_ suggests the use of `events`_ hooks to expand functionality.


.. _openedx-events: https://github.com/openedx/openedx-events
.. _openedx-filters: https://github.com/openedx/openedx-filters
.. _filters: https://github.com/openedx/openedx-filters/blob/a4a192e1cac0b70bed31e0db8e4c4b058848c5c4/openedx_filters/learning/filters.py
.. _a pipeline: https://github.com/openedx/edx-platform/blob/40613ae3f47eb470aff87359a952ed7e79ad8555/docs/guides/hooks/filters.rst#implement-pipeline-steps
.. _filter: https://github.com/openedx/openedx-filters/blob/a4a192e1cac0b70bed31e0db8e4c4b058848c5c4/openedx_filters/learning/filters.py
.. _the auto tagging pipeline: https://github.com/openedx/edx-platform/blob/40613ae3f47eb470aff87359a952ed7e79ad8555/docs/guides/hooks/filters.rst#implement-pipeline-steps
.. _hooks documentation: https://github.com/openedx/edx-platform/blob/master/docs/guides/hooks/index.rst
.. _events: https://github.com/openedx/edx-platform/blob/master/docs/guides/hooks/events.rst
.. _a receiver: https://github.com/openedx/edx-platform/blob/master/docs/guides/hooks/events.rst#receiving-events