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

Add FileInstallationStore to OAuth docs #1329

Merged
merged 4 commits into from
Feb 23, 2022

Conversation

srajiang
Copy link
Member

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 [ ])

@codecov
Copy link

codecov bot commented Feb 23, 2022

Codecov Report

Merging #1329 (131fd91) into main (5b4d9ce) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           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.

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

@@ -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.
Copy link
Member Author

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.

Copy link
Member

Choose a reason for hiding this comment

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

Makes sense!

docs/_basic/authenticating_oauth.md Show resolved Hide resolved
@@ -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.
Copy link
Member

Choose a reason for hiding this comment

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

Makes sense!

@seratch seratch added the docs M-T: Documentation work only label Feb 23, 2022
@seratch seratch added this to the 3.10.0 milestone Feb 23, 2022
Copy link
Contributor

@misscoded misscoded left a 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.

docs/_basic/authenticating_oauth.md Outdated Show resolved Hide resolved
docs/_basic/authenticating_oauth.md Outdated Show resolved Hide resolved
docs/_basic/authenticating_oauth.md Outdated Show resolved Hide resolved
@srajiang srajiang merged commit 113bbab into slackapi:main Feb 23, 2022
@srajiang srajiang deleted the docs-improve-auth branch February 23, 2022 18:22
@yamashush yamashush mentioned this pull request Dec 24, 2022
2 tasks
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.

Document the FileInstallationStore App option
3 participants