Remove workspace app references from docs #668
Conversation
Codecov Report
@@ Coverage Diff @@
## master #668 +/- ##
==========================================
- Coverage 91.94% 91.92% -0.02%
==========================================
Files 7 7
Lines 484 483 -1
Branches 90 90
==========================================
- Hits 445 444 -1
Misses 22 22
Partials 17 17
Continue to review full report at Codecov.
|
docs/_pages/getting_started.md
Outdated
|
|
||
| Our app has described which scope it desires in the workspace, but a user hasn't authorized those scopes for the development workspace yet. Scroll up and click "Install App". You'll be taken to your app installation page. This page is asking you for permission to install the app in your development workspace with specific capabilities. That's right, the development workspace is like every other workspace -- apps must be authorized by a user each time it asks for more permissions. | ||
|
|
||
| Go ahead and click "Continue". The next page asks you which conversations the app should be able to post messages in. In this case, choose "No channels", which still allows the app to directly message users who install the App -- which means you. | ||
|
|
||
| When you return to the OAuth & Permissions page copy the OAuth Access Token (it should begin with `xoxa`). Treat this value like a password and keep it safe. The Web API uses tokens to to authenticate the requests your app makes. In a later step, you'll be asked to use this token in your code. | ||
| When you return to the OAuth & Permissions page copy the OAuth Access Token (it should begin with `p`). Treat this value like a password and keep it safe. The Web API uses tokens to to authenticate the requests your app makes. In a later step, you'll be asked to use this token in your code. |
There was a problem hiding this comment.
I think "it should begin with xoxp" 😅
|
|
||
| Our app has described which scope it desires in the workspace, but a user hasn't authorized those scopes for the development workspace yet. Scroll up and click "Install App". You'll be taken to your app installation page. This page is asking you for permission to install the app in your development workspace with specific capabilities. That's right, the development workspace is like every other workspace -- apps must be authorized by a user each time it asks for more permissions. | ||
|
|
||
| Go ahead and click "Continue". The next page asks you which conversations the app should be able to post messages in. In this case, choose "No channels", which still allows the app to directly message users who install the App -- which means you. | ||
|
|
||
| When you return to the OAuth & Permissions page copy the OAuth Access Token (it should begin with `xoxa`). Treat this value like a password and keep it safe. The Web API uses tokens to to authenticate the requests your app makes. In a later step, you'll be asked to use this token in your code. | ||
| When you return to the OAuth & Permissions page copy the OAuth Access Token (it should begin with `xoxp`). Treat this value like a password and keep it safe. The Web API uses tokens to to authenticate the requests your app makes. In a later step, you'll be asked to use this token in your code. |
There was a problem hiding this comment.
amended fix for
(it should begin with p)
to
(it should begin with xoxp)
docs/_pages/web_client.md
Outdated
| @@ -233,164 +231,6 @@ Note that when calling a method with no required arguments, you **still need to | |||
|
|
|||
| --- | |||
|
|
|||
| ### Using refresh tokens | |||
There was a problem hiding this comment.
I think removing this section (and the following section) would leave users who have already built a Workspace App without information about how these options work. Instead, I think we can add warnings (similar to how the reference documentation on the options to the constructor were given warnings) to help users understand that this usage only works with the now-deprecated workspace app tokens (xoxa).
docs/_pages/web_client.md
Outdated
| @@ -186,14 +184,14 @@ getAllChannels() | |||
|
|
|||
| ### Calling methods on behalf of users | |||
|
|
|||
| When using [workspace tokens](https://api.slack.com/docs/working-with-workspace-tokens), some methods allow your app | |||
| to perform the action [on behalf of a user](https://api.slack.com/docs/working-for-users). To use one of these methods, | |||
| When using [User tokens/Personal tokens](https://api.slack.com/docs/token-types#user), some methods allow your app | |||
There was a problem hiding this comment.
For consistency, we should invent the new term "Personal tokens". Let's just stick with "user tokens".
|
@jharrilim thanks so much for contributing to making our documentation better and clearer. we really appreciate it. i left a few comments about pieces i think we can improve upon. let me know how you feel about those -- if you could update the PR to address them it would be great! |
|
Sorry for taking awhile to update it. I made the requested changes. Happy holidays! |
|
@jharrilim thanks so much for following through! 🙌 |
Summary
Requirements (place an
xin each[ ])