Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📝 WalkthroughWalkthroughAdds a new "Self-hosting 101" documentation page describing Plane self-hosting, licensing, components, operational responsibilities, and lifecycle phases, and updates the docs sidebar to link to the new guide. ChangesSelf-hosting Documentation & Navigation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Tip 💬 Introducing Slack Agent: The best way for teams to turn conversations into code.Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.
Built for teams:
One agent for your entire SDLC. Right inside Slack. 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 |
There was a problem hiding this comment.
🧹 Nitpick comments (2)
docs/self-hosting/self-hosting-101.md (2)
36-36: ⚡ Quick winComplete the phrase for clarity.
The cell content "Real and ongoing" appears incomplete. Consider clarifying what is "real and ongoing."
✏️ Proposed fix
-| Operational overhead | Zero | Real and ongoing | +| Operational overhead | Zero | Real and ongoing overhead |🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/self-hosting/self-hosting-101.md` at line 36, The table cell currently reads "Real and ongoing" and is ambiguous; update the content in docs/self-hosting/self-hosting-101.md to a complete phrase such as "Real and ongoing maintenance and operational costs" (or similar clear wording) so the Operational overhead row reads e.g. "Real and ongoing maintenance and costs" to clarify what is meant by "Real and ongoing."
31-31: ⚡ Quick winStandardize time format for consistency.
Use "20 minutes" instead of "20mins" for consistency with professional documentation standards.
✏️ Proposed fix
-| Time to first user | About 30 seconds | 20mins via Docker | +| Time to first user | About 30 seconds | 20 minutes via Docker |🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/self-hosting/self-hosting-101.md` at line 31, Replace the shorthand "20mins" in the table row for "Time to first user" with the standardized "20 minutes" to match the existing "About 30 seconds" format; update the cell text that currently reads "20mins via Docker" to "20 minutes via Docker" in the markdown table so the time format is consistent across the document.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@docs/self-hosting/self-hosting-101.md`:
- Line 36: The table cell currently reads "Real and ongoing" and is ambiguous;
update the content in docs/self-hosting/self-hosting-101.md to a complete phrase
such as "Real and ongoing maintenance and operational costs" (or similar clear
wording) so the Operational overhead row reads e.g. "Real and ongoing
maintenance and costs" to clarify what is meant by "Real and ongoing."
- Line 31: Replace the shorthand "20mins" in the table row for "Time to first
user" with the standardized "20 minutes" to match the existing "About 30
seconds" format; update the cell text that currently reads "20mins via Docker"
to "20 minutes via Docker" in the markdown table so the time format is
consistent across the document.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 281c2fee-f901-4880-af15-2ddf2a384d8b
📒 Files selected for processing (2)
docs/.vitepress/config.mtsdocs/self-hosting/self-hosting-101.md
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/self-hosting/self-hosting-101.md`:
- Line 31: Update the table copy to improve readability and consistency by
replacing "20mins" with "20 min" (or "~20 minutes") and changing "On demand" to
"on-demand" wherever those entries appear (e.g., the cell currently reading
"20mins via Docker" and any cell reading "On demand"); ensure the casing and
hyphenation match other rows for a consistent user-facing style.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 0e2a0662-e46c-4866-ba7a-efc4b00192dc
📒 Files selected for processing (1)
docs/self-hosting/self-hosting-101.md
|
|
||
| | Dimension | [Plane Cloud](https://app.plane.so/sign-in) | Self-hosted | | ||
| | --------------------------------- | ------------------------------------------- | --------------------------------------------- | | ||
| | Time to first user | About 30 seconds | 20mins via Docker | |
There was a problem hiding this comment.
Polish table copy for readability and consistency
Two entries read awkwardly for user-facing docs: 20mins and On demand. Consider 20 min (or ~20 minutes) and on-demand for consistency and clarity.
Suggested edit
-| Time to first user | About 30 seconds | 20mins via Docker |
+| Time to first user | About 30 seconds | ~20 minutes via Docker |
...
-| Cost model | Per-seat subscription | Per-seat subscription + On demand |
+| Cost model | Per-seat subscription | Per-seat subscription + on-demand |Also applies to: 41-41
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/self-hosting/self-hosting-101.md` at line 31, Update the table copy to
improve readability and consistency by replacing "20mins" with "20 min" (or "~20
minutes") and changing "On demand" to "on-demand" wherever those entries appear
(e.g., the cell currently reading "20mins via Docker" and any cell reading "On
demand"); ensure the casing and hyphenation match other rows for a consistent
user-facing style.
Description
docs/self-hosting/self-hosting-101.mdas the conceptual entry point for self-hosting — covers what self-hosting Plane involves, Cloud vs self-hosted tradeoffs, the two-layer licensing model (AGPL Community vs Commercial vs Airgapped), what your team operates, and how to plan a deployment.docs/.vitepress/config.mtsso it surfaces ahead of the deployment scenarios on the overview page.Type of Change
Screenshots and Media (if applicable)
None
Test Scenarios
None
References
None
Summary by CodeRabbit