Skip to content

Commit

Permalink
Documentation - Make option to send notifications to slack users more…
Browse files Browse the repository at this point in the history
… visible (#408)

* Updated language to help make users aware of the option to use a slack user ID for notifications

* Update global.jelly
  • Loading branch information
c1505 authored and timja committed Nov 28, 2018
1 parent 8b28b38 commit 314e5be
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 6 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,13 @@ ID*** field:

![image][img-token-credential]

# Direct Message

You can send messages to channels or you can notify individual users via their
slackbot. In order to notify an individual user, use the syntax `@user_id` in
place of the project channel. Mentioning users by display name may work, but it
is not unique and will not work if it is an ambiguous match.

# Bot user option

This plugin supports sending notifications via bot users. You can enable bot
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@
<f:checkbox field="botUser"/>
</f:entry>

<f:entry title="Project Channel" help="/plugin/slack/help-projectConfig-slackRoom.html">
<f:entry title="Project Channel or Slack User ID" help="/plugin/slack/help-projectConfig-slackRoom.html">
<f:textbox field="room" />
</f:entry>
<f:validateButton
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
<f:entry title="Is Bot User?" help="/plugin/slack/help-globalConfig-botUser.html">
<f:checkbox field="botUser" />
</f:entry>
<f:entry title="Channel" help="/plugin/slack/help-globalConfig-slackRoom.html">
<f:entry title="Channel or Slack ID" help="/plugin/slack/help-globalConfig-slackRoom.html">
<f:textbox field="room" />
</f:entry>
<f:validateButton
Expand Down
4 changes: 2 additions & 2 deletions src/main/webapp/help-globalConfig-slackRoom.html
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<div>
<p>
Enter the channel names to which notifications should be sent. Note that this can include names of
Enter the channel names or user ids to which notifications should be sent. Note that this can include names of
channels OR channel id numbers, e.g. "#builds", and that multiple values may appear comma separated.
While names are more readable, channel ids will not change over time and are therefore more resilient.
While names are more readable, channel ids will not change over time and are therefore more resilient.
</p>
<p>
It is possible to override this setting per project.
Expand Down
4 changes: 2 additions & 2 deletions src/main/webapp/help-projectConfig-slackRoom.html
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<div>
<p>
Enter the channel names to which notifications should be sent. Note that this can include names of
Enter the channel names or user ids to which notifications should be sent. Note that this can include names of
channels OR channel id numbers, e.g. "#builds", and that multiple values may appear comma separated.
While names are more readable, channel ids will not change over time and are therefore more resilient.
While names are more readable, channel ids will not change over time and are therefore more resilient.
</p>
<p>
This overrides the global setting.
Expand Down

0 comments on commit 314e5be

Please sign in to comment.