-
Notifications
You must be signed in to change notification settings - Fork 399
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
Add FileInstallationStore to OAuth docs #1329
Conversation
Codecov Report
@@ Coverage Diff @@
## main #1329 +/- ##
=======================================
Coverage 72.72% 72.72%
=======================================
Files 17 17
Lines 1463 1463
Branches 436 436
=======================================
Hits 1064 1064
Misses 310 310
Partials 89 89 Continue to review full report at Codecov.
|
@@ -24,20 +62,18 @@ const app = new App({ | |||
clientSecret: process.env.SLACK_CLIENT_SECRET, | |||
stateSecret: 'my-state-secret', | |||
scopes: ['chat:write'], | |||
// optional code for directInstall. Defaults to false. When set to true, user does not see "Add to Slack" button page. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I felt that including this additional code block was adding additional bloat to an already pretty big section. I've added a git permalink instead that points to the lines in the example oauth app where directInstall option can be seen clearly.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Makes sense!
5efcc2b
to
ddf96a0
Compare
@@ -24,20 +62,18 @@ const app = new App({ | |||
clientSecret: process.env.SLACK_CLIENT_SECRET, | |||
stateSecret: 'my-state-secret', | |||
scopes: ['chat:write'], | |||
// optional code for directInstall. Defaults to false. When set to true, user does not see "Add to Slack" button page. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Makes sense!
ddf96a0
to
c3d09e4
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great job! Much clearer.
Summary
Fixes #1305 by adding a section that describes how to use
FileInstallationStore
to speed up development of oauth app.Additionally, this OAuth documentation has gotten bloated due to lots of necessary and good elaboration and detail added over time. I've done my best to cut down some of that bloat while retaining the essential points.
Reviewers if you could build the docs locally and just give me feedback on whether this has improved readability that'd be great.
Requirements (place an
x
in each[ ]
)