openedx / openedx/openedx-filters
Include comprehensive list real life usage
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:
It was hard at first to get my head around the possibilities that the Filters framework offers -- because the possibilities are basically endless. It helped to see some of the custom filters that eduNEXT has built.
Maybe if the docs linked to as many different kinds of implementations as possible, that would help uptake?
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 with the linked community survey and review the repository's existing documentation for the Filters framework. Done means documenting a comprehensive set of real-world implementations, including the eduNEXT examples mentioned in the issue; no file or test is named, so the documentation location and scope need to be established first.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100