Skip to content
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.

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

Updated documentation for Granular Bot Permissions #943

Merged
merged 3 commits into from Jan 21, 2020

Conversation

stevengill
Copy link
Member

Summary

Updating the documentation in preparation for granular bot permissions. Also added a warning for RTM users not to update.

Related to #938

Requirements (place an x in each [ ])

@codecov
Copy link

codecov bot commented Jan 13, 2020

Codecov Report

Merging #943 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@          Coverage Diff          @@
##           master   #943   +/-   ##
=====================================
  Coverage      95%    95%           
=====================================
  Files          12     12           
  Lines         741    741           
  Branches      166    166           
=====================================
  Hits          704    704           
  Misses         13     13           
  Partials       24     24
Flag Coverage Δ
#eventsapi 89.61% <ø> (ø) ⬆️
#interactivemessages 95.23% <ø> (ø) ⬆️
#webapi 97.88% <ø> (ø) ⬆️
#webhook 87.5% <ø> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a4f3d50...84c4caa. Read the comment docs.

docs/_main/getting_started.md Outdated Show resolved Hide resolved
docs/_main/getting_started.md Outdated Show resolved Hide resolved
docs/_main/getting_started.md Outdated Show resolved Hide resolved
docs/_main/getting_started.md Outdated Show resolved Hide resolved
docs/_main/getting_started.md Outdated Show resolved Hide resolved
docs/_main/getting_started.md Outdated Show resolved Hide resolved
docs/_main/getting_started.md Outdated Show resolved Hide resolved
docs/_main/getting_started.md Outdated Show resolved Hide resolved
@@ -12,6 +12,8 @@ order: 4
The `@slack/rtm-api` package contains a simple, convenient, and configurable client for receiving events and sending simple messages to Slack's [Real Time Messaging API](https://api.slack.com/rtm). Use it in your
app to stay connected to the Slack platform over a persistent Websocket connection.

**Note**: RTM isn't available for modern scoped apps anymore. We recommend using the [Events API](https://slack.dev/node-slack-sdk/events-api) and [Web API](https://slack.dev/node-slack-sdk/web-api) instead. If you need to use RTM (possibly due to corporate firewall limitations), you can do so by creating a [legacy scoped app](#TODO). If you have an existing RTM app, do not update its scopes as it will be updated to a modern scoped app and stop working with RTM.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can't merge until we have a link for the #TODO

@shaydewael
Copy link
Contributor

Looks good, all minor changes. Thanks @stevengill 🙌

@stevengill stevengill added the docs M-T: Documentation work only label Jan 14, 2020
@stevengill
Copy link
Member Author

Thanks @shaydewael! I updated based on your feedback. Now we wait for the missing link.

@stevengill stevengill merged commit 649b0c7 into slackapi:master Jan 21, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs M-T: Documentation work only
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants