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

docs: improve GitHub Apps compatibility info #817

Closed
loozhengyuan opened this issue Jun 13, 2021 · 0 comments · Fixed by #818
Closed

docs: improve GitHub Apps compatibility info #817

loozhengyuan opened this issue Jun 13, 2021 · 0 comments · Fixed by #818
Labels
Provider Type: Documentation Improvements or additions to documentation

Comments

@loozhengyuan
Copy link
Contributor

loozhengyuan commented Jun 13, 2021

With #753, users can use GitHub Apps as an authentication method but this is not compatible with all API endpoints. The provider documentation does include this disclaimer but does not indicate which data sources or resources are incompatible with it. If the auth method is incompatible with a particular data source or resource, it should be indicated accordingly so users can be better informed before they select a particular auth method or when they encounter API-related errors when using the GitHub Apps auth method.

@loozhengyuan loozhengyuan changed the title docs: undocumented GitHub Apps incompatibility docs: improve GitHub Apps compatibility info Jun 13, 2021
@jcudit jcudit added Type: Documentation Improvements or additions to documentation Provider labels Jun 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Provider Type: Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants