Update SSO images and other minor fixes #164
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
WalkthroughDocumentation updates: standardized branding from "Plane One" to "Plane", renamed plan tiers to "Pro" and "Business", replaced several OAuth/SAML image references, and added image frames for GitHub and Google OAuth in self-hosting guides. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (6)
images/custom-sso/github-oauth.pngis excluded by!**/*.pngimages/custom-sso/google-oauth.pngis excluded by!**/*.pngimages/custom-sso/oidc-config.pngis excluded by!**/*.pngimages/custom-sso/oidc-oauth.pngis excluded by!**/*.pngimages/custom-sso/saml-config.pngis excluded by!**/*.pngimages/custom-sso/saml-oauth.pngis excluded by!**/*.png
📒 Files selected for processing (6)
plane-one/governance/authentication/custom-sso.mdx(1 hunks)self-hosting/govern/github-oauth.mdx(1 hunks)self-hosting/govern/google-oauth.mdx(1 hunks)self-hosting/govern/oidc-sso.mdx(2 hunks)self-hosting/govern/saml-sso.mdx(2 hunks)self-hosting/manage/migrate-plane.mdx(1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📓 Common learnings
Learnt from: Prashant-Surya
Repo: makeplane/developer-docs PR: 143
File: api-reference/byoa/build-plane-app.mdx:629-657
Timestamp: 2025-09-15T07:57:58.327Z
Learning: In documentation files for makeplane/developer-docs, the maintainers prefer to keep code examples simple with placeholder values (like hardcoded credentials) rather than using environment variables or complex setup, as it makes the documentation more readable and easier to understand for users learning the API.
🔇 Additional comments (8)
self-hosting/govern/github-oauth.mdx (1)
25-25: Verify image asset exists before deployment.Line 25 references a new image file
/images/custom-sso/github-oauth.png. This image must exist in thepublic/images/custom-sso/directory for the documentation to render correctly, otherwise users will see a broken image placeholder.The shell script above will verify whether this and related OAuth configuration images exist in the repository.
plane-one/governance/authentication/custom-sso.mdx (1)
5-5: LGTM: Branding standardization is consistent across SSO documentation.The text change from "Plane One enables custom SSO" to "Plane enables custom SSO" aligns with the broader PR objective to standardize product branding. This is a non-functional, low-risk update that improves consistency across the documentation set.
self-hosting/manage/migrate-plane.mdx (1)
20-21: LGTM: Plan tier terminology updated accurately.The change from "One or Pro" to "Pro or Business" reflects the current plan naming convention. This update ensures the migration documentation references the correct tier names for the Commercial Edition. The change is contextually appropriate and improves clarity for users working with paid workspaces.
self-hosting/govern/google-oauth.mdx (1)
28-28: Verify image asset exists before deployment.Line 28 references a new image file
/images/custom-sso/google-oauth.png. This image must exist in thepublic/images/custom-sso/directory for proper rendering. The verification shell script above will confirm availability of this and related OAuth configuration images.self-hosting/govern/oidc-sso.mdx (2)
6-6: LGTM: Plan tier labeling modernized consistently.The blockquote-formatted plan label now correctly displays "Pro, Business" instead of "Plane One, Plane Pro". This formatting and terminology change aligns with the broader rebranding across the SSO documentation suite and maintains consistency with related files.
8-8: LGTM: Branding text simplified appropriately.The text change from "Plane One enables custom SSO" to "Plane enables custom SSO" standardizes the branding language across the documentation and removes product-specific references that could become stale.
self-hosting/govern/saml-sso.mdx (2)
6-6: LGTM: Plan tier labeling modernized consistently.The blockquote-formatted plan label now correctly displays "Pro, Business" instead of "Plane One, Plane Pro", consistent with the broader documentation rebranding across the SSO configuration guides.
8-8: LGTM: Branding text simplified appropriately.The text change from "Plane One enables custom SSO" to "Plane enables custom SSO" maintains consistency with similar updates across the documentation and removes product-specific references.
Description
Type of Change
Screenshots and Media (if applicable)
Test Scenarios
References
Note
Refreshes SSO/OAuth docs with new configuration images, updates plan tier labels, and minor wording fixes.
oidc-config.png→oidc-oauth.png,saml-config.png→saml-oauth.pnginplane-one/governance/authentication/custom-sso.mdx,self-hosting/govern/oidc-sso.mdx, andself-hosting/govern/saml-sso.mdx.Plane OnewithPlane.Plane One, Plane ProtoPro, Businesson self-hosted OIDC/SAML pages./images/custom-sso/github-oauth.png)./images/custom-sso/google-oauth.png).One or Pro→Pro or Business).Written by Cursor Bugbot for commit c40cde4. This will update automatically on new commits. Configure here.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.