openedx / openedx/openedx-events
Clarity about which events are event-bus capable and the differences between bus and non-bus events
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 13
- Forks
- 33
- Avg merge
- 14h 37m
- Merged PRs (30d)
- 4
Description
Description
Some comments I've gathered from the community survey on the challenges/suggestions section:
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.
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 existing autodoc support for events and the event and filter documentation in openedx-events. Identify how events outside edx-platform are currently listed and how event-bus-capable events differ from non-bus events. Done means a comprehensive, maintainable list and clear explanation of those differences.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100