Skip to content

Provider documentation #459

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.

Sign up for GitHub

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

Jump to bottom
Closed
martincostello opened this issue Jul 10, 2020 · 1 comment · Fixed by #460
Closed

Provider documentation #459

martincostello opened this issue Jul 10, 2020 · 1 comment · Fixed by #460
Assignees
@martincostello
Labels
enhancement
Milestone
3.1.3

Comments

@martincostello
Copy link
Member

For cases where configuration of the provider is either not as simple as just setting the client Id and secret (such as Apple), or there are extra options that can be used (such as GitHub Enterprise), we should add some minimal documentation for users on how to configure them rather than leaving them to work it out from the code.

The providers that have extra options are:

  1. Amazon
  2. Apple
  3. BattleNet
  4. Bitbucket
  5. Discord
  6. EVEOnline
  7. Foursquare
  8. GitHub
  9. Gitee
  10. Instagram
  11. LinkedIn
  12. Odnoklassniki
  13. Okta
  14. Patreon
  15. QQ
  16. Reddit
  17. Salesforce
  18. StackExchange
  19. SuperOffice
  20. Trakt
  21. Twitch
  22. Vkontakte
  23. Weibo
@martincostello martincostello added this to the 3.1.3 milestone Jul 10, 2020
@martincostello martincostello self-assigned this Jul 10, 2020
@martincostello
Copy link
Member Author

I'll try and do this today or tomorrow, then I'll push out the 3.1.3 release with the SuperOffice fix.

martincostello added a commit to martincostello/AspNet.Security.OAuth.Providers that referenced this issue Jul 10, 2020
@martincostello
Add provider documentation index
d3704cd 
Add an initial documentation index for the providers for aspnet-contrib#459.
@martincostello martincostello mentioned this issue Jul 11, 2020
Merged
martincostello added a commit that referenced this issue Jul 11, 2020
@martincostello
Provider documentation (#460)
7d84184 
* Add provider documentation index

Add an initial documentation index for the providers for #459.

* Link to ClientId and ClientSecret

Link to the Microsoft documentation for ClientId and ClientSecret.
Add missing github.md file.

* Link to docs from README

Link to the new docs from the README.

* Add Amazon docs

Add the Amazon provider documentation.

* Add provider-specific documentation

Add some provider-specific documentation for BattleNet through GitHub.

* Add Instagram provider documentation

Relates to #441.

* Tidy up XML documentation

Tidy up some of the XML documentation for the Discord and Instagram options.

* More provider documentation

Add docs for LinkedIn through to QQ.

* Add remaining provider documentation

Add documentation for the Reddit through Weibo providers.

* Tidy up XML documentation

Update some property documentation for consistency and clarity.

* Simplify constant usage

Add a static for SuperOfficeAuthenticationConstants to make the code lines shorter.

* Document Apple provider properties

Add documentation for the Apple provider's configuration options.

* Link to enumerations

Add links to the definition of the different enumerations.

* Fix class name

Fix incorrect class name being used.

* Update index

Add the required/optional values for all providers.

* Minor docs tidy-up

Format string constants as strings.
Add link to enum.

* Fix typo

Use the right kind of apostrophe.

* Link to OAuthOptions

Add a link to the OAuthOptions class.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@martincostello martincostello

Labels
enhancement
Milestone
3.1.3
Development

Successfully merging a pull request may close this issue.

Provider documentation martincostello/AspNet.Security.OAuth.Providers
1 participant
@martincostello