Fixes on Slack Connector Documentation file #2023
Conversation
There was a problem hiding this comment.
Thanks for this @andrianalazana. We recently merged a log of fixes to CI so if you update your PR to the latest commit and resolve the conflicts things should pass here.
docs/connectors/slack.md
Outdated
| ```eval_rst | ||
| .. note:: | ||
| You should follow the instructions for the Event API first when configuring your slack connector, even if you are planning | ||
| on using slack in Socket Mode. | ||
| ``` |
There was a problem hiding this comment.
Event API does not need to be used first. You can use Socket Mode even without the Event API. Generally, the documentation related to the connection with slack is a little bit unclear, that's why this pr.
There was a problem hiding this comment.
Event API does not need to be used first.
We generally recommend everyone set up the event API because it is more fully featured than the Socket API. That's why this message is here.
There was a problem hiding this comment.
I understand the situation. However, the current note stating that the Event API is a prerequisite even for Socket Mode may not be entirely accurate. Would it be acceptable if I modified the note to recommend using the Event API for its full features?
There was a problem hiding this comment.
ok! I'll come back later with the changes. Thanks
|
Now that #2038 has been merged could you clean this PR up? |
|
I've made the changes. Let me know if something else is missing! Thanks |
docs/connectors/slack.md
Outdated
| You should follow the instructions for the Event API first when configuring your slack connector, even if you are planning | ||
| on using slack in Socket Mode. | ||
| ``` | ||
| > **_NOTE:_** While it is not mandatory to configure the Event API before using Slack in Socket Mode, we recommend setting up the Event API for its full feature set. |
There was a problem hiding this comment.
Can you put this back inside the eval_rst block and use the note directive as it was before?
Description
This pull request addresses documentation issues in the Slack connector. While navigating through the Slack connector process, I identified several errors in the documentation and meticulously corrected them.
Status
READY
Type of change
How Has This Been Tested?
I've connected Opsdroid to Slack twice, paying close attention each time. I found errors and misunderstandings in the documentation, so I suggested improvements.
Checklist: