New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Linking documentation needs work #574

Open

vranki opened this issue Mar 4, 2021 · 1 comment

Labels

T-Documentation Z-Good-First-Issue

vranki commented Mar 4, 2021

Is your feature request related to a problem? Please describe.

The documentation on linking rooms is difficult to follow and incomplete.

https://matrix-appservice-slack.readthedocs.io/en/latest/link_channels/

Describe the solution you'd like

This could be fixed with documenting a few things:

Slack bot token seems to be difficult to find on Slack side. Provide instructions where to find it.
Linking requires team_id parameter which is not even mentioned at all in the documentation
Permission required for Slack bot are not documented.
Permissions required for Matrix bot are not documented.

Author

vranki commented Mar 4, 2021

Related: #348 #427

jaller94 added T-Documentation Z-Good-First-Issue labels

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment