In T141884#2574102, @jmatazzoni wrote:@Trizek-WMF Below please find my effort at creating a "form" that can be used in Phabricator so that people can supply the information necessary to create a new notification. It's intended to guide people on all the points they need to think through. It will also help us review people's ideas and QA them when the time comes.
For clarity, I added a filled-in version of the form below the empty one. Including such an example is probably a good idea, so people can see what we're looking for.
Finally, it's necessary to put virtually all of the items inside the brackets here onto the glossary you're creating. You could literally make each of these bracketed items a link. Clicking on these links would explain, for example, what the difference is between the header and the body, or what would determine whether a message should be bundled or not.
BASIC INFORMATION
- [notification name] :
- [what triggers notification?] :
- ["Notice" or "Alert"?] :
- [will this be a bundled notification?] :
WORDING
[single message]
- [header] :
- [body] :
[Bundled Messages]
- [main, bundling message] :
- [subsidiary, bundled message] :
LINKS
- [primary link target] :
- [primary link label] :
- [#1 secondary link target :
- [#1 secondary link label] :
- [#2 secondary link target] :
- [#2 secondary link label] :
[ICON--See list of existing icons]
- [icon name] :
[EXAMPLE OF FILLED OUT FORM]
BASIC INFORMATION
- [notification name] : flow-post-reply
- [what triggers notification?]] : someone posts in a Flow topic you are watching
- ["Notice" or "Alert"?]] : Notice
- [will this be a bundled notification?]] : yes
WORDING
[single message]
- [header] : Username replied in "Topicname".
- [body] : Excerpt of the message.
[Bundled Messages]
- [main, bundling message] : 5 new replies in "Topicname".
- [subsidiary, bundled message] : Username: "Excerpt of the message..."
LINKS
- [primary link target] : The "reply" (i.e. the new post)]
- [primary link label] : View message
- [#1 secondary link target] : the user page of the user who did the action
- [#1 secondary link label] : the username of the user who did the action
- [#2 secondary link target] : null
- [#2 secondary link label] : null
[ICON--See list of existing icons]
- [icon name] : User talk
In T141884#2586360, @Trizek-WMF wrote:Note about forms on Phabricator: here is the doc.