openedx / openedx/openedx-events
Determine configuration strategy for new events
Open
Nobody has claimed this yet.
event-bus
- Dominant language
- Python
- Stars
- 13
- Forks
- 33
- Avg merge
- 14h 37m
- Merged PRs (30d)
- 4
Description
A/C
- An ADR detailing how new events will be rolled out to the community
Since https://github.com/openedx/openedx-events/pull/249, new events can be added to the event bus via configuration only (no code changes). Some options for how we would roll out new events:
- All events are off by default. New events are added to the configuration map in the producing service's configuration file with
enabled=Falseso people know what events are available - All events are on by default. New events are added to the configuration map in the config with
enabled=True - All new events start disabled by default, but are updated to be enabled by default as part of a planned release (with the change noted in the release notes)
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 reading pull request #249 and the event-bus configuration behavior it introduced. Compare the three rollout options in the issue, then document the selected strategy in an ADR, including how new events are configured and communicated to the community.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 25/100