Skip to content

Commit 9864c96

Browse files
committed
add announcement bot doc
1 parent 362fa9a commit 9864c96

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
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+
9+
Reach out to the 'sig-contribex-comms' channel in kubernetes slack for permissions or for posting something on your behalf.
10+
11+
### Adding bot to a channel
12+
13+
In order for the bot to send message to a channel, it needs to be part of the channel first and before you add it, you need to join the channel. Although we have it added in most of the channels, it still might be required to be added to a new channel. Follow the below steps for doing this
14+
15+
16+
1. Go to the 'More' option in the top left side and then go to 'Apps'
17+
![](https://i.imgur.com/Dk26HwP.png)
18+
19+
20+
2. That will take you to the apps page & choose 'Announcement bot' in this page
21+
![](https://i.imgur.com/x3x3TQ6.png)
22+
23+
24+
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
25+
![](https://i.imgur.com/x7umv6O.png)
26+
27+
28+
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
29+
![](https://i.imgur.com/It5K1sH.png)
30+
31+
32+
33+
## Pushing announcements through the bot
34+
35+
1. From any page on slack, find the '+' button called as "Attachments & shortcuts" in the text box
36+
![](https://i.imgur.com/njN9Xqq.png)
37+
38+
2. In the options displayed, click on 'Browse all shortcuts'
39+
![](https://i.imgur.com/pmVMWzS.png)
40+
41+
3. In the following page choose 'Announcement bot'
42+
![](https://i.imgur.com/1eQVBWk.png)
43+
44+
4. In the options displayed for 'Announcement bot' click on 'Post message' which open the message form
45+
![](https://i.imgur.com/M3mI3Jg.png)
46+
47+
5. In the form, choose the channel(s), write the message that needs to be sent and click on 'submit' buttom.
48+
The keyboard here might not support slack emoji search (with `:`) The workaround for this is to copy emojis
49+
![](https://i.imgur.com/FlZdGgi.png)

0 commit comments

Comments
 (0)