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.

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

docs: update auth docs + add new storefront guides #9020

Merged
merged 11 commits into from
Sep 6, 2024
Merged

docs: update auth docs + add new storefront guides #9020

merged 11 commits into from
Sep 6, 2024

Conversation

shahednasser
Copy link
Member

  • Update auth docs with latest changes to authentication flows
  • Add documentation for Google and GitHub providers
  • Add storefront guides for social-login (using Google as an example)
  • Update the OAS for auth routes.

Note: This also includes documentation updates based on PR #9013. So, it should only be merged after that one is merged and published.

@shahednasser shahednasser requested a review from a team as a code owner September 5, 2024 14:50
@vercel Vercel
Copy link

vercel bot commented Sep 5, 2024 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
api-reference 🔄 Building (Inspect) Visit Preview 💬 Add feedback Sep 5, 2024 4:26pm
api-reference-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 5, 2024 4:26pm
docs-ui ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 5, 2024 4:26pm
docs-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 5, 2024 4:26pm
medusa-dashboard ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 5, 2024 4:26pm
resources-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 5, 2024 4:26pm
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
medusa-docs ⬜️ Ignored (Inspect) Visit Preview Sep 5, 2024 4:26pm

@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Sep 5, 2024 •
edited
Loading

⚠️ No Changeset found

Latest commit: fb3a9dc

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

sradevski
sradevski reviewed Sep 5, 2024
View reviewed changes
Copy link
Member

@sradevski sradevski left a comment

Choose a reason for hiding this comment

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

Hey Shahed let me know if you want to go through the oauth flow, just to make sure we are on the same page on how it works :)

www/apps/resources/app/commerce-modules/auth/auth-flows/page.mdx Outdated Show resolved Hide resolved
www/apps/resources/app/commerce-modules/auth/auth-flows/page.mdx Outdated Show resolved Hide resolved
www/apps/resources/app/commerce-modules/auth/auth-providers/github/page.mdx Outdated Show resolved Hide resolved
www/apps/resources/app/commerce-modules/auth/auth-providers/github/page.mdx Outdated Show resolved Hide resolved
www/apps/resources/app/commerce-modules/auth/authentication-route/page.mdx Outdated Show resolved Hide resolved
www/apps/resources/app/commerce-modules/auth/authentication-route/page.mdx Outdated Show resolved Hide resolved
shahednasser and others added 4 commits September 5, 2024 19:09
@shahednasser @sradevski
Update www/apps/resources/app/commerce-modules/auth/auth-providers/gi…
e83c5ba 
…thub/page.mdx

Co-authored-by: Stevche Radevski <sradevski@live.com>
@shahednasser @sradevski
Update www/apps/resources/app/commerce-modules/auth/auth-providers/gi…
b00763a 
…thub/page.mdx

Co-authored-by: Stevche Radevski <sradevski@live.com>
@shahednasser @sradevski
Update www/apps/resources/app/commerce-modules/auth/authentication-ro…
28377be 
…ute/page.mdx

Co-authored-by: Stevche Radevski <sradevski@live.com>
@shahednasser
address PR comments
ae755ab
@shahednasser
Copy link
Member Author

@sradevski thanks for the review! Actually I forgot to update some parts as I misunderstood the authentication flow at first (what I messaged you about basically 😄) so I forgot to update some parts that you caught. I think the rest of the PR conveys the correct flow, but please feel free to give it another review in case I missed something else

sradevski
sradevski approved these changes Sep 6, 2024
View reviewed changes
Copy link
Member

@sradevski sradevski left a comment

Choose a reason for hiding this comment

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

LGTM, nice 👍

@shahednasser
Copy link
Member Author

@olivermrbl we need to merge this one once the refresh token feature is out

@shahednasser shahednasser merged commit a28c911 into develop Sep 6, 2024
32 checks passed
@shahednasser shahednasser deleted the docs/auth-updates branch September 6, 2024 12:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@olivermrbl olivermrbl olivermrbl approved these changes

@sradevski sradevski sradevski approved these changes

Assignees
No one assigned
Labels
team: medusa type: docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@shahednasser @sradevski @olivermrbl