search

readthedocs / ext-theme

Read the Docs drop in replacement site templates
2 stars 2 forks source link

Audit on-site notifications #27

Open humitos opened 3 years ago

humitos commented 3 years ago

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.

(from https://github.com/readthedocs/readthedocs.org/blob/b68a92106b5926c7e708f77aa3d04e2f30b0a24b/readthedocs/oauth/notifications.py#L44-L48)

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

astrojuanlu commented 3 years ago

When you say "audit", do you mean "tracking them on our changes audit system", or "review them"?

humitos commented 3 years ago

Only review them, closely, 🕵🏼

agjohnson commented 3 years ago

It would help to have these issues as actionable issues on this repository for now. I'm not sure this issue will be super actionable as it just requires another round of QA on notifications. I'll break out an issue that can be addressed for the integrations notification for now though. I've also added another round of QA on notifications back to our roadmap.

agjohnson commented 9 months ago

@humitos anything in particular we want to address here? I feel like we've been through a few rounds here already and there isn't anything super actionable on the new dashboard side of things.

humitos commented 9 months ago

I don't have any immediate actionable work here but I assume there are a bunch of notifications with not clear enough instructions about how to solve the problem --as the one showed in the description, which it has its own issue now at #28

I'd say the work required here is:

  1. open all the notifications.py and messages.py files
  2. read each of the notifications, follow the link and double check the user has all the information required to solve the problem

If 2) fails, we should open an issue per notification not passing that step --or fix it immediately if it's easy.

agjohnson commented 9 months ago

Makes sense. I think this is probably a backend change then, so I'll remove it from this roadmap and it might make sense to move this off this repo too.