Skip to content

docs: add Self-hosting 101 introduction page #272

Open
vihar wants to merge 3 commits intomasterfrom
self-hosting-101
Open

docs: add Self-hosting 101 introduction page #272
vihar wants to merge 3 commits intomasterfrom
self-hosting-101

Conversation

@vihar
Copy link
Copy Markdown
Contributor

@vihar vihar commented May 5, 2026

Description

  • Adds docs/self-hosting/self-hosting-101.md as 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.
  • Wires the new page into the self-hosting sidebar in docs/.vitepress/config.mts so it surfaces ahead of the deployment scenarios on the overview page.
  • Intended as the "read this first" page for evaluators deciding between Plane Cloud and self-hosting, before they hit the overview/deployment guides.

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)

None

Test Scenarios

None

References

None

Summary by CodeRabbit

  • Documentation
    • Added "Self-hosting 101" guide covering what self-hosting is, edition/license model, license activation and failure modes, runtime and data components, operator skills and time estimates, deployment/operation/upgrade guidance, patterns/anti-patterns, production checklist, and next steps.
    • Documents edition boundaries including AGPL usage and guidance on when self-hosting is appropriate.
    • Added sidebar navigation entry linking to the new guide.

@vercel
Copy link
Copy Markdown

vercel Bot commented May 5, 2026

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

Project Deployment Actions Updated (UTC)
developer-docs Ready Ready Preview, Comment May 5, 2026 10:58am

Request Review

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 5, 2026

📝 Walkthrough

Walkthrough

Adds 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.

Changes

Self-hosting Documentation & Navigation

Layer / File(s) Summary
Documentation Content
docs/self-hosting/self-hosting-101.md
New comprehensive guide covering self-hosting scope, Cloud vs self-hosted comparison, edition vs plan mechanics (Community/Commercial/Airgapped), license activation and sync, AGPL boundaries, when to self-host, runtime & data-layer components, operator skills/time budgets, lifecycle phases (deploy/configure/operate/upgrade), deployment patterns/anti-patterns, production checklist, and next steps/links.
Navigation Wiring
docs/.vitepress/config.mts
Inserted sidebar entry { text: "Self-hosting 101", link: "/self-hosting/self-hosting-101" } under the "/self-hosting/" section.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰 In burrows of docs I pen the way,
For hosts who choose their own array.
Licenses, services, and plans in sight,
Operators ready for day or night.
Hop forth—deploy with careful delight.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: add Self-hosting 101 introduction page' accurately and concisely describes the main change: adding a new documentation page for self-hosting fundamentals.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch self-hosting-101

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.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


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
Copy Markdown

@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.

🧹 Nitpick comments (2)
docs/self-hosting/self-hosting-101.md (2)

36-36: ⚡ Quick win

Complete 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 win

Standardize 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

📥 Commits

Reviewing files that changed from the base of the PR and between f22b3de and fd75633.

📒 Files selected for processing (2)
  • docs/.vitepress/config.mts
  • docs/self-hosting/self-hosting-101.md

Copy link
Copy Markdown

@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

🤖 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

📥 Commits

Reviewing files that changed from the base of the PR and between fd75633 and be743a0.

📒 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 |
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

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.

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.

2 participants