Update SSO images and other minor fixes #164
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
WalkthroughDocumentation updates across multiple files to standardize product branding from "Plane One" to "Plane," update plan tier naming from "Plane One, Plane Pro" to "Pro, Business," refresh OAuth configuration image references, and add visual aids to authentication guides. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Tip 📝 Customizable high-level summaries are now available in beta!You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.
Example instruction:
Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later. 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.
| </Tip> | ||
|
|
||
| <Frame></Frame> | ||
| <Frame></Frame> |
There was a problem hiding this comment.
🧩 Analysis chain
Verify old image is fully deprecated and new image exists.
Line 36 updates the image reference from /images/custom-sso/oidc-config.png to /images/custom-sso/oidc-oauth.png. This is a visual asset update that requires:
- The new image file (
oidc-oauth.png) to exist inpublic/images/custom-sso/ - Confirmation that the old image (
oidc-config.png) is no longer referenced elsewhere in the codebase
The verification script above will check for image file existence. To verify no lingering references to the old image, run:
🏁 Script executed:
rg -n "oidc-config\.png" --type mdxLength of output: 27
I'll verify the image update by searching for all references to the old image without file type restrictions and checking for the existence of both image files.
---
🏁 Script executed:
```shell
#!/bin/bash
# Search for any remaining references to the old image file (all file types)
echo "=== Searching for references to oidc-config.png ==="
rg -n "oidc-config\.png" || echo "No references found"
echo -e "\n=== Checking for new image file ==="
find . -name "oidc-oauth.png" -type f 2>/dev/null || echo "New image file not found"
echo -e "\n=== Checking for old image file ==="
find . -name "oidc-config.png" -type f 2>/dev/null || echo "Old image file not found"
echo -e "\n=== Listing files in public/images/custom-sso/ directory ==="
ls -la public/images/custom-sso/ 2>/dev/null || echo "Directory does not exist or is empty"
Length of output: 386
Update references to deleted image file in all documentation files.
The new image file (oidc-oauth.png) exists and is correct. However, the old image file (oidc-config.png) has been removed from the repository, but a reference to it remains at plane-one/governance/authentication/custom-sso.mdx:33. This will result in a broken image link. Update this reference to use the new image path: /images/custom-sso/oidc-oauth.png.
🤖 Prompt for AI Agents
In self-hosting/govern/oidc-sso.mdx around line 36 and
plane-one/governance/authentication/custom-sso.mdx around line 33, update the
broken image reference that still points to the deleted oidc-config.png to the
new image path /images/custom-sso/oidc-oauth.png; replace the old filename in
the markdown image tag (or any HTML <img>/<Frame> tag) with the new path and
verify the image renders correctly.
| ### On Plane | ||
|
|
||
| <Frame></Frame> | ||
| <Frame></Frame> |
There was a problem hiding this comment.
🧩 Analysis chain
Verify old image is fully deprecated and new image exists.
Line 52 updates the image reference from /images/custom-sso/saml-config.png to /images/custom-sso/saml-oauth.png. This visual asset update requires:
- The new image file (
saml-oauth.png) to exist inpublic/images/custom-sso/ - Confirmation that the old image (
saml-config.png) is no longer referenced elsewhere
To verify no lingering references to the old images, run:
🏁 Script executed:
rg -n "saml-config\.png|oidc-config\.png" --type mdxLength of output: 27
I need to retry the search without the mdx file type restriction and verify the image files. Let me generate new scripts to check both the old image references and the new image's existence.
---
🏁 Script executed:
```shell
#!/bin/bash
# Search for old image references across all files
echo "=== Searching for saml-config.png references ==="
rg -n "saml-config\.png" 2>/dev/null || echo "No matches found"
echo ""
echo "=== Searching for oidc-config.png references ==="
rg -n "oidc-config\.png" 2>/dev/null || echo "No matches found"
echo ""
echo "=== Checking if new image file exists ==="
ls -la public/images/custom-sso/saml-oauth.png 2>/dev/null || echo "File not found at public/images/custom-sso/saml-oauth.png"
echo ""
echo "=== Listing all files in public/images/custom-sso/ ==="
ls -la public/images/custom-sso/ 2>/dev/null || echo "Directory not found"
Length of output: 530
I've found critical issues. Let me gather more information about the file structure and confirm the relationship between these files.
---
🏁 Script executed:
```shell
#!/bin/bash
# Check if the file under review exists
echo "=== Checking file under review ==="
ls -la self-hosting/govern/saml-sso.mdx 2>/dev/null || echo "Not found at self-hosting/govern/saml-sso.mdx"
echo ""
echo "=== Checking if it's at the other path ==="
ls -la plane-one/governance/authentication/custom-sso.mdx 2>/dev/null || echo "Not found at plane-one/governance/authentication/custom-sso.mdx"
echo ""
echo "=== Searching for all public/images directories ==="
find . -type d -name "images" 2>/dev/null | head -20
echo ""
echo "=== Searching for any saml-oauth.png files ==="
find . -name "saml-oauth.png" 2>/dev/null || echo "Not found"
echo ""
echo "=== Checking public directory structure ==="
ls -la public/ 2>/dev/null || echo "public/ not found"
Length of output: 468
Let me verify the exact content at line 52 of the file under review and check whether both files need to be updated.
---
🏁 Script executed:
```shell
#!/bin/bash
# Show content around line 52 in the file under review
echo "=== Content at line 52 in self-hosting/govern/saml-sso.mdx ==="
sed -n '50,54p' self-hosting/govern/saml-sso.mdx
echo ""
echo "=== Content at line 103 in plane-one/governance/authentication/custom-sso.mdx ==="
sed -n '101,105p' plane-one/governance/authentication/custom-sso.mdx
echo ""
echo "=== Content at line 33 in plane-one/governance/authentication/custom-sso.mdx ==="
sed -n '31,35p' plane-one/governance/authentication/custom-sso.mdx
Length of output: 617
Update the related documentation file to use the new image reference.
The change in self-hosting/govern/saml-sso.mdx line 52 is correct—the new image saml-oauth.png exists at ./images/custom-sso/. However, the old image references are not fully deprecated. The related file plane-one/governance/authentication/custom-sso.mdx still references the old images:
- Line 103:
saml-config.png(should besaml-oauth.png) - Line 33:
oidc-config.png(unchanged, but check if it should match the migration pattern)
Update line 103 in plane-one/governance/authentication/custom-sso.mdx to use saml-oauth.png for consistency across documentation.
🤖 Prompt for AI Agents
In plane-one/governance/authentication/custom-sso.mdx around line 103, update
the image reference from saml-config.png to saml-oauth.png so it matches the new
image used in self-hosting/govern/saml-sso.mdx; open the file, replace the old
image filename at line 103 with saml-oauth.png, save and verify the image path
remains ./images/custom-sso/saml-oauth.png and renders correctly.
Description
Type of Change
Screenshots and Media (if applicable)
Test Scenarios
References
Note
Updates SSO documentation by revising plan labels, swapping OIDC/SAML images, and adding GitHub/Google OAuth configuration screenshots.
self-hosting/govern/oidc-sso.mdx,self-hosting/govern/saml-sso.mdx):Plane One, Plane ProtoPro, Business.oidc-config.png→oidc-oauth.png,saml-config.png→saml-oauth.png.plane-one/governance/authentication/custom-sso.mdx):self-hosting/govern/github-oauth.mdx): Add configuration screenshotimages/custom-sso/github-oauth.png.self-hosting/govern/google-oauth.mdx): Add configuration screenshotimages/custom-sso/google-oauth.png.self-hosting/manage/migrate-plane.mdx)ProandBusinessinstead ofOneandPro.Written by Cursor Bugbot for commit 28b03bb. This will update automatically on new commits. Configure here.
Summary by CodeRabbit
Documentation
✏️ Tip: You can customize this high-level summary in your review settings.