docs: Add GitHub IDP docs

[vfiruz97]

Docs serverpod/serverpod#4546.
@marcelomendoncasoares, please, review.

[marcelomendoncasoares]

Thanks for the quick iteration with the docs, @vfiruz97! Docs looks good overall, following the standard of the other IDPs very well. Made a few suggestions to clarify some points and reorganize some details to improve the UX.

On the custom overrides, I think we'll need to convert it into a menu following the same style of the IDPs - after all, it is just like an IDP. The file is currently very long and with parts that can be removed to avoid redundancy.

Ping me back when you are ready for another review!

[vfiruz97]

Hi @marcelomendoncasoares,
Great review, thanks a lot. I have addressed them and everything's ready for you to check.

[marcelomendoncasoares]

Nice improvements! A few more comments, specially regarding the OAuth2 utility setup guide. I have answered about the GitHubOAuthCredentials on the comments.

Also, there are a few links that needs fixing after transforming the custom providers into a menu.

  Exhaustive list of all broken links found:
  - Broken link on source page path = /next/concepts/authentication/basics:
     -> linking to providers/custom-providers (resolved as: /next/concepts/authentication/providers/custom-providers)
  - Broken link on source page path = /next/concepts/authentication/providers/custom-providers/oauth2-utility/oauth2-utility-basic:
     -> linking to ../github/setup (resolved as: /next/concepts/authentication/providers/custom-providers/github/setup)
  - Broken link on source page path = /next/concepts/authentication/providers/custom-providers/overview:
     -> linking to ./oauth2-utility (resolved as: /next/concepts/authentication/providers/custom-providers/oauth2-utility)

[vfiruz97]

Hi @marcelomendoncasoares,
Great suggestions as always! I've addressed all comments. Also fixed broken links and the menu order.
Ready for review!

We removed GitHubOAuthCredentials from the docs, and I'll apply the same fix in Serverpod as well.
Would you prefer that I push the fix as a follow-up to the already merged PR (#4546), or open a fresh PR based on the latest main? I'd also like to include the discussed OAuth2PkceTokenResponse change from #4642, if that works for you.

[marcelomendoncasoares]

We removed GitHubOAuthCredentials from the docs, and I'll apply the same fix in Serverpod as well. Would you prefer that I push the fix as a follow-up to the already merged PR (#4546), or open a fresh PR based on the latest main? I'd also like to include the discussed OAuth2PkceTokenResponse change from #4642, if that works for you.

A fresh PR is better. I think it make sense to already bundle the referenced changes from the discussion on the Twitch PR!

[marcelomendoncasoares]

Great work! Changes are complete now, with only two minor fixes. I'll just wait for the changes on the GitHubIdpConfig and OAuth2PkceTokenResponse to approve.

[vfiruz97]

A fresh PR is better. I think it make sense to already bundle the referenced changes from the discussion on the Twitch PR!

Cool! I will address the comments soon. I opened a PR regarding GitHubIdpConfig and OAuth2PkceTokenResponse in #4676.
I'm waiting for your feedback on that, and then I'll adjust the docs for OAuth2PkceTokenResponse accordingly.

[marcelomendoncasoares]

Since the other PR is nearly done, I'll already approve this one! Just please review if the latest changes on serverpod/serverpod#4676 require changing anything on the Creating an OAuth2-based Identity Provider guide.

[vfiruz97]

Since the other PR is nearly done, I'll already approve this one! Just please review if the latest changes on serverpod/serverpod#4676 require changing anything on the Creating an OAuth2-based Identity Provider guide.

Cool! Yeah I will do small adjusting on the Creating an OAuth2-based Identity Provider guide after getting serverpod/serverpod#4676 merged. There I am waiting your reply.

[vfiruz97]

I made a small tweak related to the changes in serverpod/serverpod#4676. Whether we expose Duration or int for expiresIn does not affect the doc, since OAuth2PkceTokenResponse is not documented explicitly. It is ready.

[marcelomendoncasoares]

I made a small tweak related to the changes in serverpod/serverpod#4676. Whether we expose Duration or int for expiresIn does not affect the doc, since OAuth2PkceTokenResponse is not documented explicitly. It is ready.

Nice! Feature complete, then!! 🎉