Skip to content

Commit cb6b95f

Browse files
authored
Merge pull request #7440 from SD-13/announce_bot_doc
Add slack announcement bot doc
2 parents ab77eaf + 06c912c commit cb6b95f

File tree

10 files changed

+48
-0
lines changed

10 files changed

+48
-0
lines changed
44 KB
Loading
192 KB
Loading
6.27 KB
Loading
22.1 KB
Loading
9.96 KB
Loading
19.3 KB
Loading
22.7 KB
Loading
5.73 KB
Loading
25.3 KB
Loading
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# K8s Announcement Bot User guide
2+
3+
The source code for this bot is present in https://github.com/kubernetes-sigs/slack-infra/tree/main/slack-post-message and it is deployed using https://github.com/kubernetes/k8s.io/tree/main/apps/slack-infra
4+
5+
## Prerequisites
6+
7+
### Permissions
8+
To use the bot, the user must be a member of the Slack 'sig-contributor-comms' group. Contact @contributor-comms to obtain the necessary permissions or to post something on your behalf.
9+
10+
### Adding bot to a channel
11+
12+
To allow the bot to send messages to a channel, it must first be added to the channel. Before adding it, you need to make sure that the bot has already joined the channel. Although the bot is added to most of the channels, it might still be necessary to add it to a new channel. Follow the steps below to do so.
13+
14+
15+
1. Go to the 'More' option in the top left side and then go to 'Apps'
16+
<img src="./announcementbot-images/add-bot-to-channel/step-1.png">
17+
18+
19+
2. That will take you to the apps page & choose 'Announcement bot' in this page
20+
<img src="./announcementbot-images/add-bot-to-channel/step-2.png">
21+
22+
23+
3. Now, slack will take you to a DM page with the bot. Click on the title of the bot at the top of this page
24+
<img src="./announcementbot-images/add-bot-to-channel/step-3.png">
25+
26+
27+
4. In the pop-up click on 'Add this app to a channel' & enter the channel name. This will have add the bot to the specified channel
28+
<img src="./announcementbot-images/add-bot-to-channel/step-4.png>
29+
30+
31+
32+
## Pushing announcements through the bot
33+
34+
1. From any page on slack, find the '+' button called as "Attachments & shortcuts" in the text box
35+
<img src="./announcementbot-images/make-announcement/step-1.png">
36+
37+
2. In the options displayed, click on 'Browse all shortcuts'
38+
<img src="./announcementbot-images/make-announcement/step-2.png">
39+
40+
3. In the following page choose 'Announcement bot'
41+
<img src="./announcementbot-images/make-announcement/step-3.png">
42+
43+
4. In the options displayed for 'Announcement bot' click on 'Post message' which open the message form
44+
<img src="./announcementbot-images/make-announcement/step-4.png">
45+
46+
5. In the form, choose the channel(s), write the message that needs to be sent and click on 'submit' buttom.
47+
The keyboard here might not support slack emoji search (with `:`) The workaround for this is to copy emojis
48+
<img src="./announcementbot-images/make-announcement/step-5.png">

0 commit comments

Comments
 (0)