openedx / openedx/docs.openedx.org
New Documentation: Using Waffles for Incremental Rollout
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 35
- Forks
- 95
- Avg merge
- 5d 15h
- Merged PRs (30d)
- 3
Description
The edx-platform and most other core services have the ability to use waffle flags. These flags are actually quite capable and can do inceremntal and percentage wise rollout, https://waffle.readthedocs.io/en/stable/types/flag.html#flag-attributes but there is no documentation or references for how to do this in the edx-platform. It would be useful to have a page in our docs that goes over this capability, links to the upstream docs and shows how to use this capability in the open edx ecosystem.
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 Waffle flag attributes documentation, then review how edx-platform and other Open edX core services use Waffle flags. Document incremental and percentage-based rollout, link to the upstream reference, and include Open edX ecosystem usage examples; done means the capability is explained for Open edX readers.
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
- Mostly clear
- Newbie friendliness
- 45/100