diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/index.markdown | 1 | ||||
-rw-r--r-- | doc/screenshots/mention-autocomplete.png | bin | 0 -> 3066 bytes | |||
-rw-r--r-- | doc/user-mentions.markdown | 17 |
3 files changed, 18 insertions, 0 deletions
diff --git a/doc/index.markdown b/doc/index.markdown index 3a779d5c..4393ee5d 100644 --- a/doc/index.markdown +++ b/doc/index.markdown @@ -45,6 +45,7 @@ Using Kanboard - [Create tasks by email](create-tasks-by-email.markdown) - [Subtasks](subtasks.markdown) - [Analytics for tasks](analytics-tasks.markdown) +- [User mentions](mentions.markdown) ### Working with users and groups diff --git a/doc/screenshots/mention-autocomplete.png b/doc/screenshots/mention-autocomplete.png Binary files differnew file mode 100644 index 00000000..f23fb6d1 --- /dev/null +++ b/doc/screenshots/mention-autocomplete.png 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. |