Skip to content

RDoc-3882 Document GitHub and Google OAuth login support#2467

Merged
ppekrol merged 2 commits into
ravendb:mainfrom
PFYasu:RDoc-3882
Jun 11, 2026
Merged

RDoc-3882 Document GitHub and Google OAuth login support#2467
ppekrol merged 2 commits into
ravendb:mainfrom
PFYasu:RDoc-3882

Conversation

@PFYasu

@PFYasu PFYasu commented May 26, 2026

Copy link
Copy Markdown
Contributor

Issue link

https://issues.hibernatingrhinos.com/issue/RDoc-3882

Additional description

Documents the new GitHub and Google OAuth sign-in flow in RavenDB Cloud (RDBCL-5177 / Cloud PR #4215).

cloud/cloud-overview.mdx

  • Section ## Login To Your Account — refreshed intro noting that users can sign in either with a magic link or via GitHub/Google.
    • Existing magic-link content kept under a new #### Login with a magic link heading.
    • New #### Login with GitHub or Google subsection covering:
      • The two new Login via GitHub / Login via Google buttons on the login page
      • Flow: authorize at the provider, return to RavenDB Cloud, match by email
      • 2FA behavior (prompted after OAuth authorization, same as for magic link)
      • "No Cloud account for the email" path: a Check your inbox page is shown and a sign-in / registration link is emailed, with the registration form pre-filled with the email
  • Section ## Register Your Account — short info admonition noting that registration can also be initiated from the login page via GitHub or Google.
  • In-page TOC updated with the new login subsections.

Screenshots

Two screenshots added:

  • cloud/assets/login-page-oauth-buttons.png — login page showing GitHub / Google buttons
  • cloud/assets/login-oauth-check-email-page.pngCheck your inbox page after OAuth login with an unregistered email

Type of change

  • Content - docs
  • Content - cloud
  • Content - guides
  • Content - start pages/other
  • New docs feature (consider updating /templates or readme)
  • Bug fix
  • Optimization
  • Other

Changes in docs URLs

  • No changes in docs URLs
  • Articles are restructured, URLs will change, mapping is required (update /scripts/redirects.json file, set Documents Moved PR label)

Changes in UX/UI

  • No changes in UX/UI
  • Changes in UX/UI (include screenshots and description)

@PFYasu PFYasu marked this pull request as draft May 26, 2026 12:12
@PFYasu PFYasu added the Cloud label May 26, 2026
@PFYasu PFYasu requested review from gregolsky, mateuszbartosik and matz985 and removed request for mateuszbartosik May 26, 2026 12:26
@PFYasu PFYasu self-assigned this May 26, 2026
@PFYasu PFYasu marked this pull request as ready for review May 26, 2026 12:26
Comment thread cloud/cloud-overview.mdx
Comment on lines +172 to +175
<Admonition type="info" title="2FA">
If [2FA](../cloud/cloud-security.mdx#enable-mfa) is enabled on your account, you will be prompted
for the second factor after authorizing at GitHub or Google, just like with the magic link.
</Admonition>

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

X

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Need to write that:

Users are responsible for enabling and maintaining Two-Factor Authentication (2FA) on their designated Single Sign-On (SSO) provider.

@ppekrol ppekrol merged commit 2b5e5e4 into ravendb:main Jun 11, 2026
1 check passed
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.

3 participants