diff options
author | Frederic Guillot <fred@kanboard.net> | 2015-12-30 20:43:23 +0100 |
---|---|---|
committer | Frederic Guillot <fred@kanboard.net> | 2015-12-30 20:43:23 +0100 |
commit | a3732a949fc22619e65d0dc24f9f81cc0f87edcf (patch) | |
tree | fad22425c1a28861049aabb7e0d77eb962eb141f /doc/user-mentions.markdown | |
parent | 65f26699a63bd05859208092abb5d9ec1429a53f (diff) |
Add documentation for user mentions
Diffstat (limited to 'doc/user-mentions.markdown')
-rw-r--r-- | doc/user-mentions.markdown | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/user-mentions.markdown b/doc/user-mentions.markdown new file mode 100644 index 00000000..156456d6 --- /dev/null +++ b/doc/user-mentions.markdown @@ -0,0 +1,17 @@ +User Mentions +============= + +Kanboard offers the possibility to send notifications when someone is mentioned. + +If you need to get the attention of someone in a comment or in a task, use the @ symbol followed by their username. +Kanboard will automatically suggest a list of users: + +![User Mention](screenshots/mention-autocomplete.png) + +- At the moment, only the task description and the comment text area have this feature enabled. +- The user mentions works only during tasks and comments creation. +- To be notified, mentioned users need to be a member of the project. +- When someone is mentioned, this user will receive a notification. +- The @username mention is linked to the public user profile. + +The notification is sent according to the user settings, it can be an email, a web notification or even a message on Slack/Hipchat/Jabber if you have installed the right plugins. |