Merge pull request #7440 from SD-13/announce_bot_doc

Add slack announcement bot doc
This commit is contained in:
Kubernetes Prow Robot 2023-08-22 02:56:54 -07:00 committed by GitHub
commit cb6b95f876
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
10 changed files with 48 additions and 0 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 44 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 192 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.3 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 10 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 23 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 25 KiB

View File

@ -0,0 +1,48 @@
# K8s Announcement Bot User guide
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
## Prerequisites
### Permissions
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.
### Adding bot to a channel
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.
1. Go to the 'More' option in the top left side and then go to 'Apps'
<img src="./announcementbot-images/add-bot-to-channel/step-1.png">
2. That will take you to the apps page & choose 'Announcement bot' in this page
<img src="./announcementbot-images/add-bot-to-channel/step-2.png">
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
<img src="./announcementbot-images/add-bot-to-channel/step-3.png">
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
<img src="./announcementbot-images/add-bot-to-channel/step-4.png>
## Pushing announcements through the bot
1. From any page on slack, find the '+' button called as "Attachments & shortcuts" in the text box
<img src="./announcementbot-images/make-announcement/step-1.png">
2. In the options displayed, click on 'Browse all shortcuts'
<img src="./announcementbot-images/make-announcement/step-2.png">
3. In the following page choose 'Announcement bot'
<img src="./announcementbot-images/make-announcement/step-3.png">
4. In the options displayed for 'Announcement bot' click on 'Post message' which open the message form
<img src="./announcementbot-images/make-announcement/step-4.png">
5. In the form, choose the channel(s), write the message that needs to be sent and click on 'submit' buttom.
The keyboard here might not support slack emoji search (with `:`) The workaround for this is to copy emojis
<img src="./announcementbot-images/make-announcement/step-5.png">