openedx / openedx/openedx-filters
Cross-repo collection of all filters in the ecosystem
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 10
- Forks
- 28
- Avg merge
- 3d 8h
- Merged PRs (30d)
- 8
Description
Description
Some comments I've gathered from the community survey on the challenges/suggestions section:
I wish it was easier to see the named release when each event/filter was added. It would also be helpful to know which Open edX services an event or filter is used in (edx-platform, credentials, etc.).
Finding a comprehensive list of events/filters (especially those outside of edx-platform) is challenging, and they are not all well documented. I added autodoc support for events, but there is probably more work to be done there.
More clarity about which events are event-bus capable and the differences between bus and non-bus events would also be great.A cross-repo collection of all events / filters in the ecosystem. It would be great to have a consistent way to access permissions inside a filter. This has been a point of confusion in the instructor dashboard filter around where permissions are / should be checked.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the issue description and the linked community survey, then inventory events and filters across the named Open edX repositories. Define a consistent way to record release, service, event-bus, and permission details; done means the ecosystem has a comprehensive, maintainable collection and the documented distinctions are clear.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100