readthedocs / readthedocs/ext-theme
Audit on-site notifications
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 12
- Forks
- 6
- Avg merge
- 13h 25m
- Merged PRs (30d)
- 1
Description
We want to audit all the on-site notifications to confirm their copy makes sense and they are useful. Basically, we want to confirm if a user that reads the notification and clicks on the link to "solve the problem" has all the context required on the linked page to be able to solve it without requiring jumping into the Read the Docs documentation.
A good example of a not useful notification is the notification for a failure webhook attached:
The project {{ project.name }} doesn't have a valid webhook set up, commits won't trigger new builds for this project. See the project integrations for more information.
that links to the Admin -> Integrations page that has no context. Example: https://readthedocs.com/dashboard/readthedocs-ops/integrations/
Original card at: https://trello.com/c/tY0Mi8v4/771-audit-all-trial-subscription-emails-notifications-to-ensure-they-work-and-are-useful
Contributor guide
No contributing guide indexed for this repository
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 readthedocs/oauth/notifications.py, especially lines 44-48, and inspect the linked Admin → Integrations page. Audit the on-site notifications and their linked pages for useful context; done means each notification's copy and destination let users solve the stated problem without consulting Read the Docs documentation.
Written by the indexing model from the issue text.
Assessment
- Domain
- content
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100