Notifications docs do not explain actual mechanism
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 4
- Forks
- 71
- Avg merge
- 2d 1h
- Merged PRs (30d)
- 11
Description
This section in the documentation explains that Rucio can send notifications for events happening, but it doesn't mention what mechanism is actually used for notificications, how to listen to them etc.:
https://rucio.github.io/documentation/operator/notifications
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 Notifications page at the linked documentation URL and trace Rucio's actual notification mechanism and how users listen for events. Update that section to explain the mechanism and listening workflow, then verify the rendered page answers both questions clearly.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- Half a day
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100