Add toggle_implementation to the sphinx documentation
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 6
- Forks
- 16
- PR merge metrics
- No merged PRs in 30d
Description
The annotation toggle_implementation should be added to the sphinx documentation, because knowing that a toggle is a “DjangoSetting” vs a “CourseWaffleFlag” gives a lot of information around the capabilities of the toggle and how and where to configure it, once you understand each type of implementation.
See https://discuss.openedx.org/t/which-toggle-annotations-should-be-published/4690
Question:
- Is it enough to capture this decision in the commit comment vs an ADR?
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 in the repository's Sphinx documentation and find the existing toggle annotation entries. Document toggle_implementation, including the distinction between DjangoSetting and CourseWaffleFlag and their configuration implications. Review the linked discussion to determine whether the decision also needs an ADR; done means the annotation is covered and that documentation decision is recorded.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100