docs(providers): update providers documentation #1900
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- delineate clearly the 3 provider types (oauth, email, credentials) - make each section structure consistent - update the option list for every provider type - use emojis
|
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/nextauthjs/next-auth/9qBJB554xsoLTTR6WdvN2xt34RQW |
balazsorban44
requested changes
Apr 30, 2021
To stay consistent with the rest of our documentation, for now we should not emojis on the sections of our documentation pages.
3 tasks
balazsorban44
requested changes
May 1, 2021
balazsorban44
requested changes
May 1, 2021
Co-authored-by: Balázs Orbán <info@balazsorban.com>
|
@balazsorban44 addressed all your suggestions 🙇🏽♂️ |
balazsorban44
added a commit
that referenced
this pull request
May 6, 2021
* Constrain the adapters type generics more accurately * Add types for the incoming messages to events callbacks * Code review comments from @lluia * Rebase from trunk and fix merge conflicts * Update documentation * Rip out generics * fix(build): export aliases from client (#1909) * docs(provider): update providers documentation (#1900) * docs(providers): update providers documentation - delineate clearly the 3 provider types (oauth, email, credentials) - make each section structure consistent - update the option list for every provider type - use emojis * docs(providers): instructions on new provider types * docs(providers): remove emojis To stay consistent with the rest of our documentation, for now we should not emojis on the sections of our documentation pages. * docs(providers): reword sentence Co-authored-by: Balázs Orbán <info@balazsorban.com> * docs(providers): add tip on overriding options * docs(providers): clarify `params` option usage * docs(providers): make names list inline Co-authored-by: Balázs Orbán <info@balazsorban.com> * fix(ts): unset generics defaults for overriding (#1891) Co-authored-by: Lluis Agusti <hi@llu.lu> * fix(ts): tweak Adapter related types (#1914) Contains the following squashed commits: * fix(ts): make first adapter parameter non-optional * fix(ts): make defaulted values non-optional internally * test(ts): fix linting * fix(page): don't pass params to custom signout page (#1912) * For the custom signout page addressed two issues with the query params being added to the signout url. A conditional check on the error value is now made before adding it as a query param. Also added a conditional check on the callbackUrl and if present that then gets appended as a query param to the signout api call. * Changed fix for bug #192 to have no querystring params in the custom signout page url. Co-authored-by: anubisoft <anubisoftprez@gmail.com> Co-authored-by: Lluis Agusti <hi@llu.lu> * docs(www): fix typo (#1922) * docs(provider): Update IdentityServer 4 demo configuration (#1932) * Responding to code review comments * Fix tests * Fix lint error Co-authored-by: Lluis Agusti <hi@llu.lu> Co-authored-by: Balázs Orbán <info@balazsorban.com> Co-authored-by: Kristóf Poduszló <kripod@protonmail.com> Co-authored-by: Anubisoft <1471887+anubisoft@users.noreply.github.com> Co-authored-by: anubisoft <anubisoftprez@gmail.com> Co-authored-by: Ernie Miranda <emiranda04@users.noreply.github.com> Co-authored-by: Mathis Møller <thisen-dk@hotmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Reasoning 💡
We realised that the documentation for the different available provider options was out of date.
I took the opportunity to re-work a bit the Providers page in our docs to delineate better the 3 ways to sign-in
OAuthemailcredentialsand the steps and options for each. When listing the options for each type of provider, it took our types as the source of truth, as agreed with @balazsorban44. I also added emojis 🙈
Checklist 🧢
TestsAffected issues 🎟
#1792