From a3732a949fc22619e65d0dc24f9f81cc0f87edcf Mon Sep 17 00:00:00 2001 From: Frederic Guillot Date: Wed, 30 Dec 2015 20:43:23 +0100 Subject: [PATCH] Add documentation for user mentions --- doc/index.markdown | 1 + doc/screenshots/mention-autocomplete.png | Bin 0 -> 3066 bytes doc/user-mentions.markdown | 17 +++++++++++++++++ 3 files changed, 18 insertions(+) create mode 100644 doc/screenshots/mention-autocomplete.png create mode 100644 doc/user-mentions.markdown diff --git a/doc/index.markdown b/doc/index.markdown index 3a779d5c8..4393ee5de 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 new file mode 100644 index 0000000000000000000000000000000000000000..f23fb6d1744a44287b6efbb323fe0390a663ada2 GIT binary patch literal 3066 zcma)8c{tQx7bhyo($CWTdWl~`MYhH^5m90g*|KL)))@80%*aql6!~S#V5~zFGi0Ca z$~t3Yh%{p+VXQMMYa_hV```P=`+MH!Ip==Pea^Y}JkLGne(rs8&Bk0*_+P?&e0-u% zi_7*r9OfxfXdiE!wz{9s1Af5X+?0<%kzL?T4ux5`0(^XjC4VbFUk>(9o>2h3Y~qOg z%%-Emq}Goe{Fa*%@q96WS$Et3=fE{DgQo}{sP6eLU0Ju7sOD05T~#3&?{ZrD!8Zkg zH_}ofmPJRT1T2bMge3Y&MHYRe*`2)S1`=uX*&j8;#>v*K9nXSE<}Cm!W{G^lncXJC zG0m-$t;{zCsQkG`C`F1RpB(S1Us)Yy;ccR{EUpD97t`v9j_C%$ZWtfvxg|OR1BSnp z6uwQj5<6sH?k*CsZR*)}?G(=?;y_mH?X(L8NWykN)TKy7`A2EPQ-Zl#n(ARBuPqjQ3*JjEiD_zZlK=eSjvS z|IW>R+pEkxr%8N3#E3T}RJ}3;*XwvO`_tOEJVW2tzqAdUol9)w-=Qb!&edm~GG6_Q zje3{Y&WtQ{p{d6<+#2p02h-6XZH>0Zx?*pW<<5Te-APOttc$Aebv52*=~?3>C1Z7h zek?E4wUW!4EE!rmTVCNRKQ;@LG#qwXe=;Vjl*{rYyN4XI@buMNzWpaG6ExWPM?`(C z&6vPbPg0}e7GVP!?hydzv+XD&DBNd&GbsbIewomYgyh{&nf#fo{zT!^i>tP{kxV%y zce$;fUA~JaO9Lrtdf(nHc#c`OWVa_pEze(GWHI**Ke!G!X8kC=|w=;7zpN3@b!lC|K zhOA-(D@>9k0CKs6tV{?@fVkVNC7On>1#B8*a1;hm8Y}Sfy|v66)>_495Ty%a@px_N z@7n8t2OAu$XS+w4x4<>DtN5usCZ-0YWIPvnjkins@Xqd)-DLXFT3b452Q#;kx5;=~ z%n;4SV7oyrW1m0QirF;>QhjSDEUGUZ@fKro3E>R)%@HFj#GJn117>YuNvXyeS(d1w zbI65{s0Wb!?D+66jXfGFH4$d*cERj9Kr-~Jo+T_)aT5?A)J1z0uMwhBm03_utUE z7?~*);iYza9a%+u&OeTr8Y1=}5dkD?nc0~ZUHc$pvRX26t_MabXU%i>?|Z=Ia1^C>6Hpa_K&Y<%z>bvhp=b|1e7G+MJZQ+N^_0!QIi7f`a7zq# ze`I19s|0mFxXL8ah^sAhZG~H>$E&;=lp0xf*0vBrXS+J@U(&f@FE9XPFER zlX(XV`~M`_C#C-!xsx82?VB%9k#A{Xfys0`H;VAKe>Wo8BTrcElqHLHdQ>arc4Xt( zSsT@3u9|< zEAZ+g{R>rbmN*#)2a$q2GPB?Ds)Fc{CG)EDPlEL(_g^`T0k;sD>LlH<`w&drKMN5F z-lV2{oy+>2Ac^=2D(#P6^ddYKoV$j$W==>5CE#Z><0!7w8Gn;9Nfu1K2a`@S+jf3| zb!}DMlOV@C0rhc%6UWG%9+lr`XiCIqi(XS%QU#v%C;cbwg59ok$|Le1PH<*M+9iXQ z0;XT!vNniTth%BMB$c+s>8e`{DKCZKE ztL@R0_|5~HOS`s66^A$vTlYWN72g^mUvO$+{ebbW}F6)xj4tgR1zoe$pOx6a&yXN1F_}N-QBEBSB@5%R`Bi9WT7zc`$ zGaadQ8;`gV`ZmGo*DtDlRFBWiZE#(Gg?wa|Q+CpgqX^idKNJUs7C!sCGN2HR9lJ7m z9kT>BN2NRoeT}BeAGSC}qPxN71IS7r!^fKaH%{S6@&|8F4tdgN;dJ z=sYTQeS)!~I6F*tA^_X<(@&daf`u?Lw{7B0(K54T0Sae+rf3|tkq;?)C^NcU>uekT z-LN+})YBWnq*#T_II0FkxisO3xefCMygm}uF4NFBpF?vlJqjOMDd}xv`7sL4$c>NH zrA1`pqo0|uUMf2UEQ!Z%_u?;t>e;+$UL4AibpEnuK5* zgMNEKY%MgSyYK~L^j=r(NbWsMTc0S^$j4pPSUhVn$RJ@G(A?bXO^1W3pjB@5IIo!E zfo5(T^_GDT{gTaRCrgwTE5v`*+>dubDvVy1j!Nkf%c)eVv~j|H;?$pD`yu9YG+M}#n!I(P^Z;|F-=U;jZt@(Gxj*4MAGcRVVj1lyvQ RdH;7lsF}@Wf+_6bzXAArHTnPm literal 0 HcmV?d00001 diff --git a/doc/user-mentions.markdown b/doc/user-mentions.markdown new file mode 100644 index 000000000..156456d61 --- /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.