Skip to content

Commit

Permalink
[ISSUE #4661] Add documentation for slack sink connector. (#4662)
Browse files Browse the repository at this point in the history
* Add documentation for slack sink connector.
  • Loading branch information
yanrongzhen authored Dec 16, 2023
1 parent 61e1392 commit 2fa7017
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 0 deletions.
23 changes: 23 additions & 0 deletions eventmesh-connectors/eventmesh-connector-slack/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# eventmesh-connector-slack

## SlackSinkConnector:from eventmesh to slack。

1. launch your eventmesh-runtime.
2. enable sinkConnector and check `sink-config.yml`.
3. send a message to eventmesh with the topic defined in `pubSubConfig.subject`
```yaml
pubSubConfig:
meshAddress: 127.0.0.1:10000
subject: TEST-TOPIC-SLACK
idc: FT
env: PRD
group: slackSink
appId: 5034
userName: slackSinkUser
passWord: slackPassWord
sinkConnectorConfig:
connectorName: slackSink
# Please refer to: https://api.slack.com/messaging/sending
appToken: slackAppToken
channelId: slackChannelId
```
23 changes: 23 additions & 0 deletions eventmesh-connectors/eventmesh-connector-slack/README_CN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# eventmesh-connector-slack

## SlackSinkConnector:从 eventmesh 到 slack。

1. 启动你的 eventmesh-runtime。
2. 启用 sinkConnector 并检查 `sink-config.yml`
3. 向 eventmesh 发送带有在 `pubSubConfig.subject` 中定义的主题消息。
```yaml
pubSubConfig:
meshAddress: 127.0.0.1:10000
subject: TEST-TOPIC-SLACK
idc: FT
env: PRD
group: slackSink
appId: 5034
userName: slackSinkUser
passWord: slackPassWord
sinkConnectorConfig:
connectorName: slackSink
# 以下配置请参考文档:https://api.slack.com/messaging/sending
appToken: slackAppToken
channelId: slackChannelId
```

0 comments on commit 2fa7017

Please sign in to comment.