AS1024/Kanboard-Prod
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add documentation for user mentions

Browse Source
This commit is contained in:
Frederic Guillot
2015-12-30 20:43:23 +01:00
parent 65f26699a6
commit a3732a949f
3 changed files with 18 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
doc/user-mentions.markdown Normal file
View File

@@ -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.