Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation - Make option to send notifications to slack users more visible #408

Merged
merged 2 commits into from
Nov 28, 2018
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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="Project 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