openedx / openedx/xblocks-extra
FeedbackXBlock README suggests unsupported Tutor config format
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 0
- Forks
- 5
- Avg merge
- 9h 53m
- Merged PRs (30d)
- 11
Description
In the FeedbackXBlock readme, the recommended approach is to create a Tutor plugin as a YAML file. But plugins as YAML files are no longer the recommended approach to create Tutor plugins. Instead, plugin developers are encouraged to create either single-file Python modules or full-fledged Python packages: https://docs.tutor.edly.io/tutorials/plugin.html
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
Open the FeedbackXBlock README and locate the section recommending a YAML Tutor plugin. Compare it with the linked Tutor plugin tutorial, update the recommendation to cover single-file Python modules or full Python packages, and verify that the README no longer presents YAML plugins as the recommended approach.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 72/100