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

Create list of providers dynamically from provider docs front matter #1157

Closed
balazsorban44 opened this issue Jan 19, 2021 · 2 comments · Fixed by #1295
Closed

Create list of providers dynamically from provider docs front matter #1157

balazsorban44 opened this issue Jan 19, 2021 · 2 comments · Fixed by #1295
Labels
docs Relates to documentation enhancement New feature or request good first issue Good issue to take for first time contributors

Comments

@balazsorban44
Copy link
Member

balazsorban44 commented Jan 19, 2021

Currently, we define providers twice in the documentation. We have a www/providers.json file, but each provider documentation has the same information about the provider id and title. We could create the providers.json file out of those front matters, and add it as a pre-build step for the documentation page. This would minimize the number of files that need to be added/edited when adding a new provider.

Ref: 1a1a1f9#commitcomment-46130313

all supported providers: https://github.com/nextauthjs/next-auth/tree/canary/www/docs/providers
providers.json: https://github.com/nextauthjs/next-auth/blob/canary/www/providers.json

@balazsorban44 balazsorban44 added enhancement New feature or request docs Relates to documentation good first issue Good issue to take for first time contributors labels Jan 19, 2021
@ndom91
Copy link
Member

ndom91 commented Jan 20, 2021

Yeah great idea!

@github-actions
Copy link

🎉 This issue has been resolved in version 3.3.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Relates to documentation enhancement New feature or request good first issue Good issue to take for first time contributors
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants