Clarification for Email settings in documentation

Hi all,

I'm currently going through open issues at a new customer of mine and there's a ticket where an ex employee was tasked with writing some better documentation for the Email settings - Given that this documentation is currently very sparse, I think this would be worthwhile. The proposal would be to add a paragraph for each setting to clarify a little more what that setting means, especially for users unfamiliar with these settings.

I see that I can technically just go to the wiki page and edit the contents, but before I just go in there and do it, I wanted to ask if this is okay or if this needs some kind of vetting/review process and how that would work. I cannot promise to work regularly on documentation, though.

Additionally, there have been suggestions on that ticket that the option names could be clarified as well - which would probably be a feature request ticket, I guess?

Thanks,

Jan

Replies (2)

RE: Clarification for Email settings in documentation - Added by Holger Just 10 days ago

The wiki is free to edit and you are very much invited to improve it :)

We do not currently have a formal review process here. If you think however that things are unclear or you want to perform larger / more general changes, please feel free to ask in the forums. Maybe someone has a helpful opinion then.

Additionally, there have been suggestions on that ticket that the option names could be clarified as well - which would probably be a feature request ticket, I guess?

The actual translated names were in fact changed some time after the documentation was last updated. here are their current translations: source:tags/6.0.5/config/locales/en.yml#L954

Proposing updates for these translations would indeed be done via an issue.

RE: Clarification for Email settings in documentation - Added by Jan Krutisch 10 days ago

Thanks, Holger!

Here's my proposed changes. I'm not married to this being a table, but I think it is probably the clearest way of presenting this. The texts have been mulled over a couple of times already inside the team but that work is 9 years old, so grain of salt and all.

-----------------8<-----8<-----8<-----8<-----8<-----8<-----8<-----8<-----8<-----------------------

Users receive notifications for projects they're a member of. It's possible to receive notifications for an issue regardless the notification settings by watching it. Note that this will put your email address into the CC instead of the To field.

It's possible to pick one of these options:

For any event on all my projects	Receive all project events. No filtering is employed.
For any event on the selected projects only...	Same as "Only for things I watch or I'm involved in", but limited to the selected projects. Note: The User has to be member of the project for it to show up in this list
Only for things I watch or I'm involved in	Notify if the event is for an issue is: created by the user, assigned to the user or previously assigned to the user
Only for things I am assigned to	Notify if the event is for an issue: assigned to the user or previously assigned to the user
Only for things I am the owner of	Notify if the event is for an issue created by the user Note: Even if a ticket was assigned to the user, they won't get any notifications unless they're watching the ticket.
No events	Don't ever notify the user for events. This can be combined with watching individual tickets to selectively receive notifications.

From version 4.2.0 you can choose whether you only want to receive notifications with high importance and thus filter out changes with low priority.
You can also tick that you do not want to be notified of your own changes.

-----------------8<-----8<-----8<-----8<-----8<-----8<-----8<-----8<-----8<-----------------------

(Last paragraph is unchanged)

If nobody objects or has any requests for change, I'll change the relevant page by the end of the week, I think. Thanks in advance for your imput.

(1-2/2)

Project

General

Profile

Redmine