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 updates for OAuth overhaul #1890

Merged
merged 1 commit into from
Mar 18, 2024
Merged

Docs updates for OAuth overhaul #1890

merged 1 commit into from
Mar 18, 2024

Conversation

infomiho
Copy link
Contributor

@infomiho infomiho commented Mar 14, 2024

  • Migration docs from 0.12 to 0.13
  • Updates to Google docs
  • Updates to Github docs

@infomiho infomiho mentioned this pull request Mar 14, 2024
14 tasks
@infomiho infomiho marked this pull request as ready for review March 14, 2024 12:47
@infomiho infomiho added the auth label Mar 14, 2024
Copy link
Contributor

@sodic sodic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work!

I didn't run or check the code (I'm guessing you already covered that :).

My comments include suggestions you can implement or ignore. Merge when ready.

web/docs/auth/social-auth/github.md Outdated Show resolved Hide resolved
]
```

The fields you receive will depend on the scopes you requested. The default scope is set to `profile` only. If you want to get the user's email, you need to specify the `email` scope in the `configFn` function.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The fields you receive will depend on the scopes you requested. The default scope is set to `profile` only. If you want to get the user's email, you need to specify the `email` scope in the `configFn` function.
The fields you will receive depend on the scopes you requested. The default scope is set to `profile` only. If you want to get the user's email, you need to specify the `email` scope in the `configFn` function.

Maybe even without will, applies to other places too.

web/docs/migrate-from-0-12-to-0-13.md Outdated Show resolved Hide resolved
web/docs/migrate-from-0-12-to-0-13.md Outdated Show resolved Hide resolved
web/docs/migrate-from-0-12-to-0-13.md Outdated Show resolved Hide resolved
web/docs/migrate-from-0-12-to-0-13.md Outdated Show resolved Hide resolved
web/docs/migrate-from-0-12-to-0-13.md Outdated Show resolved Hide resolved
web/docs/migrate-from-0-12-to-0-13.md Outdated Show resolved Hide resolved
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A common theme for the suggestions (I might have missed some along the same lines).

I suggest you use:

  • "We" when you talk about the team (e.g., "we made some breaking changes...")
  • "Wasp" when you talk about the framework (e.g., "Wasp gives you access to this field").

The redirect URL for the OAuth providers has changed. You will need to update the redirect URL for the OAuth providers in the provider's dashboard.

<Tabs>
<TabItem value="before" label="Before">
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the before and after stuff, but it seems we lost the javascript/typescript split and this guide therefore only supports typescript?

No big deal, but just FYI to consider whether it makes sense in the future.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was deciding between having the complete matrix [ts, js] x [before, after] or not. It seemed cleaner to include only one of those: most people use Typescript and those using Javascript will get the idea of what needs to change.

@infomiho
Copy link
Contributor Author

I'll merge this after we merge Github and Google changes.

Copy link
Contributor

@sodic sodic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, merge when ready!

Base automatically changed from miho-arctic-integration to arctic-feature March 18, 2024 11:33
Signed-off-by: Mihovil Ilakovac <mihovil@ilakovac.com>
@infomiho infomiho merged commit 7eb20ae into arctic-feature Mar 18, 2024
@infomiho infomiho deleted the oauth-docs-update branch March 18, 2024 11:42
infomiho added a commit that referenced this pull request Mar 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants