docs: [FC-0074] glossary update #266

Apgomeznext · 2025-02-17T03:52:14Z

Description

This PR updates the glossary for the filters repository.

Supporting information

Link to other information about the change, such as Jira issues, GitHub issues, or Discourse discussions. Also, link to any relevant documentation useful for reviewers.
Be sure to check they are publicly readable, or if not, repeat the information here.

Testing instructions

Please provide detailed step-by-step instructions for testing this change, including any necessary setup, e.g., additional requirements, plugins, configuration variables, etc, and environment details to ensure the reviewer can test the change.

Deadline

"None" if there's no rush, or provide a specific date or event (and reason) if there is one.

Other information

Include anything else that will help reviewers and consumers understand the change.

Any other PRs or issues that should be linked here? Any related PRs?
Any special concerns or limitations? For example: deprecations, security, or anything you think should be noted.

Checklists

Check off if complete or not applicable:

Merge Checklist:

Post Merge:

Create a tag
Create a release on GitHub
Check new version is pushed to PyPI after tag-triggered build is
finished.
Delete working branch (if not needed anymore)
Upgrade the package in the Open edX platform requirements (if applicable)

This PR updates the glossary for the filters repository.

openedx-webhooks · 2025-02-17T03:52:19Z

Thanks for the pull request, @Apgomeznext!

This repository is currently maintained by @openedx/hooks-extension-framework.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
- This process (including the steps you'll need to take) is documented here.
If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

Dependencies

This PR must be merged before / after / at the same time as ...
Blockers

This PR is waiting for OEP-1234 to be accepted.
Timeline information

This PR must be merged by XX date because ...
Partner information

This is for a course on edx.org.
Supporting documentation
Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

The size and impact of the changes that it introduces
The need for product review
Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

mariajgrimaldi · 2025-02-17T07:45:18Z

docs/reference/glossary.rst

+   Pipeline Step
+     A pipeline step is a function within a pipeline that receives, processes, and returns data. Each step may perform operations like transforming, validating, filtering, or enriching data. Pipeline steps are implemented as classes that inherit from the base class `PipelineStep`_ and define specific logic within their `run_filter`_ method, which is executed by the pipeline tooling when the filter is triggered.
+
+   Public Filter


I've never referred to a filter as a public filter. Can we change the name only to filter?

Sure, but I think it gets a little bit confusing. What if we modify this entry to OpenEdxPublicFilter, which is used multiple times in the documentation?

Yes! That would be better :) thanks!

mariajgrimaldi · 2025-02-17T07:47:00Z

docs/reference/glossary.rst


-   Filter Configuration
-     The filter configuration is a dictionary that defines the pipeline settings for a filter. Each filter type has its own configuration, which includes settings like whether errors should fail silently or propagate, and the sequence of pipeline steps. Configurations specify the filter type, error-handling preferences, and a list of module paths for each pipeline step to be executed. E.g., the configuration for the `CourseEnrollmentStarted filter`_ might include settings like ``fail_silently: False`` and ``['my_plugin.filters.StopEnrollmentIfNotValidEmail']`` as its pipeline steps. See the :doc:`/decisions/0002-hooks-filter-config-location` for more details on the configuration format.
+   Pipeline State


Is this term used elsewhere in the documentation? It looks like a good addition, but I've never used it before, so I'm curious if it's needed.

You are right. I will erase this entry to avoid confusion among the readers.

docs/reference/glossary.rst

…y_revision

mariajgrimaldi · 2025-02-19T09:53:47Z

docs/reference/architecture-subdomains.rst

@@ -15,7 +15,7 @@ Currently, these are the `architecture subdomains`_ used by the Open edX Events
 | Enterprise        | Provides tools for organizations to manage their learners and courses.                             |
 +-------------------+----------------------------------------------------------------------------------------------------+

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


There are a few more we can consider: https://github.com/search?q=repo%3Aopenedx%2Fopenedx-filters%20architecture%20subdomain&type=code

I can update this later :)

mariajgrimaldi · 2025-02-19T09:55:42Z

docs/reference/glossary.rst

+   Pipeline Step
+     A pipeline step is a function within a pipeline that receives, processes, and returns data. Each step may perform operations like transforming, validating, filtering, or enriching data. Pipeline steps are implemented as classes that inherit from the base class `PipelineStep`_ and define specific logic within their `run_filter`_ method, which is executed by the pipeline tooling when the filter is triggered.
+
+   Public Filter


Yes! That would be better :) thanks!

mariajgrimaldi · 2025-02-19T09:56:48Z

docs/reference/glossary.rst

+     A pipeline step is a function within a pipeline that receives, processes, and returns data. Each step may perform operations like transforming, validating, filtering, or enriching data. Pipeline steps are implemented as classes that inherit from the base class `PipelineStep`_ and define specific logic within their `run_filter`_ method, which is executed by the pipeline tooling when the filter is triggered.
+
+   OpenEdxPublicFilter
+     The `OpenEdxPublicFilter`_ is a base class provided by the Open edX Filters framework. Developers create custom filters by inheriting from this class and implementing the run_filter method, which defines the filter's behavior. This class also manages the execution of the filter's pipeline and handles configuration settings.


Can we update OpenEdxPublicFilter to use this reference strategy? https://github.com/openedx/openedx-filters/pull/261/files#diff-945f73e8ec9b90d1ce37ebd8059f75364845f15c3ecb19ee3c3f089d6d40d37aR7

mariajgrimaldi · 2025-02-19T10:03:33Z

docs/reference/glossary.rst

@@ -37,3 +44,13 @@ This glossary provides a high-level overview of the key concepts and components
 .. _OpenEdxPublicFilter: https://github.com/openedx/openedx-filters/blob/main/openedx_filters/tooling.py#L14
 .. _run_pipeline: https://github.com/openedx/openedx-filters/blob/main/openedx_filters/tooling.py#L164
 .. _CourseEnrollmentStarted filter: https://github.com/openedx/openedx-filters/blob/main/openedx_filters/learning/filters.py#L142
+.. _Architecture Subdomains: https://docs.openedx.org/projects/openedx-filters/en/latest/reference/architecture-subdomains.html
+.. _Public Filter: https://docs.openedx.org/projects/openedx-filters/en/latest/reference/filters-tooling.html#openedx_filters.tooling.OpenEdxPublicFilter


Do we still need this entry?

mariajgrimaldi

LGTM! Just a few minor comments to address. Thanks! Let me know once you've resolved them, and I'll merge.

…y_revision

docs: [FC-0074] glossary update

6088bfb

This PR updates the glossary for the filters repository.

openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Feb 17, 2025

docs: update commit

0174f41

Apgomeznext marked this pull request as ready for review February 17, 2025 03:55

Apgomeznext requested a review from a team as a code owner February 17, 2025 03:55

Apgomeznext requested review from mariajgrimaldi and sarina February 17, 2025 03:56

mariajgrimaldi added the FC Relates to an Axim Funded Contribution project label Feb 17, 2025

mariajgrimaldi requested changes Feb 17, 2025

View reviewed changes

sarina requested changes Feb 17, 2025

View reviewed changes

docs/reference/glossary.rst Outdated Show resolved Hide resolved

docs/reference/glossary.rst Outdated Show resolved Hide resolved

docs/reference/glossary.rst Outdated Show resolved Hide resolved

Apgomeznext added 3 commits February 18, 2025 16:49

Merge remote-tracking branch 'upstream/main' into Apgomeznext/glossar…

bf080d1

…y_revision

docs: changes requested

d6ec5c6

docs: update commit

d438098

mariajgrimaldi reviewed Feb 19, 2025

View reviewed changes

sarina approved these changes Feb 19, 2025

View reviewed changes

mariajgrimaldi approved these changes Feb 19, 2025

View reviewed changes

Apgomeznext added 5 commits February 19, 2025 10:53

docs: update pr

7e4e208

Merge remote-tracking branch 'upstream/main' into Apgomeznext/glossar…

18dd83b

…y_revision

Merge branch 'main' into Apgomeznext/glossary_revision

8d02e28

docs: update document

ca187de

Merge remote-tracking branch 'upstream/main' into Apgomeznext/glossar…

366b9e0

…y_revision

mariajgrimaldi merged commit bfca13e into openedx:main Feb 19, 2025
11 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: [FC-0074] glossary update #266

docs: [FC-0074] glossary update #266

Apgomeznext commented Feb 17, 2025

openedx-webhooks commented Feb 17, 2025 •

edited

Loading

mariajgrimaldi Feb 17, 2025

Apgomeznext Feb 18, 2025 •

edited

Loading

mariajgrimaldi Feb 19, 2025

mariajgrimaldi Feb 17, 2025

Apgomeznext Feb 18, 2025

mariajgrimaldi Feb 19, 2025

mariajgrimaldi Feb 19, 2025

mariajgrimaldi Feb 19, 2025

mariajgrimaldi Feb 19, 2025

mariajgrimaldi Feb 19, 2025

mariajgrimaldi left a comment

docs: [FC-0074] glossary update #266

docs: [FC-0074] glossary update #266

Conversation

Apgomeznext commented Feb 17, 2025

Description

Supporting information

Testing instructions

Deadline

Other information

Checklists

openedx-webhooks commented Feb 17, 2025 • edited Loading

Choose a reason for hiding this comment

Apgomeznext Feb 18, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mariajgrimaldi left a comment

Choose a reason for hiding this comment

openedx-webhooks commented Feb 17, 2025 •

edited

Loading

Apgomeznext Feb 18, 2025 •

edited

Loading