Troubleshooting overview page, Activate Airgapped Enterprise license#234
Merged
sriramveeraghanta merged 6 commits intomasterfrom Mar 7, 2026
Merged
Troubleshooting overview page, Activate Airgapped Enterprise license#234sriramveeraghanta merged 6 commits intomasterfrom
sriramveeraghanta merged 6 commits intomasterfrom
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📝 WalkthroughWalkthroughAdds two sidebar links (Troubleshoot → Overview; Manage licenses → Activate Airgapped Enterprise), introduces new troubleshooting and license-activation pages, moves system requirements from top-level overview into the methods overview, and tightens Docker Compose prerequisites to explicit CPU, RAM, and expanded OS support. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches
🧪 Generate unit tests (beta)
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: 3
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/self-hosting/methods/overview.md (1)
1-72:⚠️ Potential issue | 🟡 MinorFix Prettier formatting to pass CI.
The pipeline reports a Prettier formatting failure on this file. Run
prettier --write docs/self-hosting/methods/overview.mdto auto-fix.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/self-hosting/methods/overview.md` around lines 1 - 72, Prettier formatting failed for this Markdown; run the formatter (prettier --write) on this file or reformat the frontmatter and JSX-like CardGroup/Card blocks to match Prettier rules (ensure consistent indentation, spacing around the YAML frontmatter, and proper line breaks for Card and CardGroup elements) so CI passes; target the "title/description/keywords" frontmatter and the CardGroup/Card components shown in the diff.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/self-hosting/troubleshoot/overview.md`:
- Around line 33-36: The links in the list use the incorrect path segment
"/self-hosting/troubleshooting/" causing 404s; update each link (e.g., the
Installation, License, CLI, and Storage links shown) to use
"/self-hosting/troubleshoot/" so they match the actual directory/sidebar
configuration (replace "/self-hosting/troubleshooting/..." with
"/self-hosting/troubleshoot/...").
- Around line 1-4: The frontmatter is missing the required keywords field;
update the markdown frontmatter to include a keywords key alongside the existing
title and description (e.g., add a "keywords: [troubleshooting, self-hosting,
Plane]" entry) so the frontmatter contains title, description, and keywords as
required by the guidelines.
- Around line 1-36: The file with frontmatter titled "Troubleshooting" fails
Prettier; reformat the document to match the project's Markdown style by running
the project's Prettier on this markdown (or apply the same formatting rules):
fix frontmatter spacing, consistent heading spacing, table alignment and code
span backticks so Prettier passes for the "Troubleshooting" doc (docs
self-hosting overview) before pushing.
---
Outside diff comments:
In `@docs/self-hosting/methods/overview.md`:
- Around line 1-72: Prettier formatting failed for this Markdown; run the
formatter (prettier --write) on this file or reformat the frontmatter and
JSX-like CardGroup/Card blocks to match Prettier rules (ensure consistent
indentation, spacing around the YAML frontmatter, and proper line breaks for
Card and CardGroup elements) so CI passes; target the
"title/description/keywords" frontmatter and the CardGroup/Card components shown
in the diff.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 997ea48a-4d16-4e9e-b5c3-80e502cb91d1
📒 Files selected for processing (5)
docs/.vitepress/config.mtsdocs/self-hosting/methods/docker-compose.mddocs/self-hosting/methods/overview.mddocs/self-hosting/overview.mddocs/self-hosting/troubleshoot/overview.md
💤 Files with no reviewable changes (1)
- docs/self-hosting/overview.md
There was a problem hiding this comment.
♻️ Duplicate comments (1)
docs/self-hosting/troubleshoot/overview.md (1)
1-4:⚠️ Potential issue | 🟡 MinorAdd missing
keywordsfield to frontmatter.The frontmatter is missing the required
keywordsfield. As per coding guidelines, every markdown page requires frontmatter withtitle,description, andkeywordsfields.📝 Proposed fix
--- title: Troubleshooting description: Diagnose and resolve issues with your self-hosted Plane instance. +keywords: plane troubleshooting, self-hosting errors, plane logs, debug plane, installation issues ---As per coding guidelines: "Every markdown page requires frontmatter with title, description, and keywords fields"
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/self-hosting/troubleshoot/overview.md` around lines 1 - 4, The frontmatter at the top of the markdown is missing the required keywords field; update the YAML frontmatter block that currently contains title and description to also include a keywords field (e.g., keywords: [plane, troubleshooting]) so the page has title, description, and keywords; edit the frontmatter region (the leading --- block) in overview.md to add the keywords entry alongside the existing title and description fields.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@docs/self-hosting/troubleshoot/overview.md`:
- Around line 1-4: The frontmatter at the top of the markdown is missing the
required keywords field; update the YAML frontmatter block that currently
contains title and description to also include a keywords field (e.g., keywords:
[plane, troubleshooting]) so the page has title, description, and keywords; edit
the frontmatter region (the leading --- block) in overview.md to add the
keywords entry alongside the existing title and description fields.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 428f89f2-c3e1-4dd6-b22d-b6350065bd9a
📒 Files selected for processing (2)
docs/self-hosting/methods/overview.mddocs/self-hosting/troubleshoot/overview.md
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
docs/self-hosting/troubleshoot/overview.md (1)
1-4:⚠️ Potential issue | 🟡 MinorAdd the missing
keywordsfrontmatter field.This page still omits
keywords, so it does not satisfy the required Markdown frontmatter shape.As per coding guidelines: "Every markdown page requires frontmatter with title, description, and keywords fields"
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/self-hosting/troubleshoot/overview.md` around lines 1 - 4, The frontmatter block is missing the required keywords field; update the YAML frontmatter at the top of the document (the block containing title and description) to add a keywords key (e.g., keywords: ["troubleshooting", "self-hosting", "plane"]) so the page satisfies the required frontmatter shape including title, description, and keywords.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/self-hosting/troubleshoot/overview.md`:
- Around line 10-12: Remove the duplicate section heading '## Identify the
service' by deleting the repeated heading on the second occurrence (the one at
Line 12) or renaming it to the intended subsection title; ensure only one '##
Identify the service' header remains to avoid duplicate anchors and noisy TOC
output and update any following content that depended on the duplicate header if
renaming.
---
Duplicate comments:
In `@docs/self-hosting/troubleshoot/overview.md`:
- Around line 1-4: The frontmatter block is missing the required keywords field;
update the YAML frontmatter at the top of the document (the block containing
title and description) to add a keywords key (e.g., keywords:
["troubleshooting", "self-hosting", "plane"]) so the page satisfies the required
frontmatter shape including title, description, and keywords.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 78ecb9b5-f6ab-4b36-bb45-b22037b8643d
📒 Files selected for processing (4)
docs/.vitepress/config.mtsdocs/public/images/activate-license/upload-airgapped-enterprise.webpdocs/self-hosting/manage/manage-licenses/activate-airgapped-enterprise.mddocs/self-hosting/troubleshoot/overview.md
✅ Files skipped from review due to trivial changes (1)
- docs/self-hosting/manage/manage-licenses/activate-airgapped-enterprise.md
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/.vitepress/config.mts
danciaclara
changed the title
sriramveeraghanta
approved these changes
Mar 7, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Type of Change
Screenshots and Media (if applicable)
Test Scenarios
References
Summary by CodeRabbit