Skip to content

Conversation

@danciaclara
Copy link
Collaborator

@danciaclara danciaclara commented Jan 22, 2026

Description

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • Feature (non-breaking change which adds functionality)
  • Improvement (change that would cause existing functionality to not work as expected)
  • Code refactoring
  • Performance improvements
  • Documentation update

Screenshots and Media (if applicable)

Test Scenarios

References

Summary by CodeRabbit

  • Documentation
    • Added a comprehensive Single Sign-On (SSO) setup guide covering domain verification, DNS notes, OIDC and SAML configuration, attribute mapping, certificates, and sign-in flow.
    • Included step-by-step UI guidance, visuals, and notes on automatic account creation on first sign-in.
    • Reorganized authentication docs and sidebar entries for easier discovery; added cross-references between workspace and project member management.

✏️ Tip: You can customize this high-level summary in your review settings.

@vercel
Copy link

vercel bot commented Jan 22, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Review Updated (UTC)
docs Ready Ready Preview, Comment Jan 23, 2026 7:57am

Request Review

@coderabbitai
Copy link

coderabbitai bot commented Jan 22, 2026

📝 Walkthrough

Walkthrough

Adds a new Single Sign-On (SSO) documentation page, updates project/workspace member cross-reference links, and consolidates authentication entries in the sidebar to reference the unified SSO doc.

Changes

Cohort / File(s) Change Summary
New SSO documentation
docs/authentication/sso.mdx
Added a comprehensive SSO setup guide covering domain verification, DNS notes, OIDC and SAML configuration steps, IdP registration details, attribute mappings, certificate handling, UI guidance, and post-configuration sign-in behavior.
Project/workspace member docs
docs/core-concepts/projects/manage-project-members.mdx, docs/core-concepts/workspaces/members.mdx
Updated an invitation link target and added a "See also" cross-reference to link project and workspace member management pages.
Sidebar/navigation
sidebars.ts
Reworked Authentication section: added authentication/sso entry and replaced multiple protocol-specific links with a single "Self-hosted authentication" reference to the consolidated SSO doc.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

🐰 I hopped through docs at break of dawn,

Verified domains on the dewy lawn,
OIDC, SAML — ribbons tied, not frayed,
Links now cross and the sidebar's made,
A carrot-cheer for SSO, well-played! 🥕

🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'SSO Cloud' is vague and does not clearly describe the main changes in the changeset, which include adding SSO documentation, updating cross-references, and restructuring the authentication sidebar. Consider a more descriptive title such as 'Add SSO configuration documentation and update authentication sidebar' to better reflect the actual changes.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
docs/core-concepts/projects/manage-project-members.mdx (1)

158-166: Duplicate section detected.

The "How users join projects" section (lines 158-166) is a duplicate of lines 119-127. This appears to be an accidental copy that should be removed.

🗑️ Proposed fix: Remove duplicate section
 This audit trail helps project admins monitor membership changes and verify that access permissions are correct. Activity is retained for project history.

-## How users join projects
-
-Users can become project members in two different ways, and understanding both helps you manage your project team effectively.
-
-**Direct project membership** is where you specifically invite users to your project and assign them roles. These members have access only to the projects you've added them to, and you have full control over their permissions.
-
-**Teamspace-based membership** happens automatically when your project is linked to a [Teamspace](/core-concepts/workspaces/teamspaces). All members of that teamspace automatically receive `Member` access to your project, making it perfect for teams that collaborate across multiple projects.
-
-Users can have both types of access simultaneously. When this happens, Plane automatically applies whichever role gives them higher permissions. For example, if someone is a `Guest` on your project but joins a linked teamspace, they're automatically upgraded to `Member` access. If they're already an `Admin`, they keep their `Admin` role.
-
 ## See also
 - [Manage workspace members](/core-concepts/workspaces/members)
🤖 Fix all issues with AI agents
In `@docs/authentication/sso.mdx`:
- Around line 32-37: Remove the duplicated instruction "Copy the **TXT record
value**" — keep it only once between Step 4 and Step 5 in the SSO setup text;
specifically, edit the steps that currently read "Step 4: In the **Verify your
domain** modal that appears, copy the **TXT record value**." and "Step 5: Copy
the **TXT record value**." so that only one of those lines remains (either keep
the detailed Step 4 or collapse Step 5 into a single continuation line).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants