Skip to content

Update Airgapped Edition#255

Merged
danciaclara merged 5 commits intomasterfrom
update-airgapped-edition
Apr 1, 2026
Merged

Update Airgapped Edition#255
danciaclara merged 5 commits intomasterfrom
update-airgapped-edition

Conversation

@danciaclara
Copy link
Copy Markdown
Collaborator

@danciaclara danciaclara commented Apr 1, 2026

Description

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)

Test Scenarios

References

Summary by CodeRabbit

  • Documentation
    • Added step-by-step upgrade guides for Airgapped Edition on Docker and on Kubernetes
    • Renamed sidebar links from “For Docker/For Kubernetes” to “On Docker/On Kubernetes” under Install
    • Added a collapsed “Airgapped Edition” submenu under Self-hosting → Manage → Update Plane
    • Updated eligibility badges and messaging, and added a Deployment methods section linking Docker and Kubernetes paths

@vercel
Copy link
Copy Markdown

vercel bot commented Apr 1, 2026

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

Project Deployment Actions Updated (UTC)
developer-docs Ready Ready Preview, Comment Apr 1, 2026 0:06am

Request Review

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 1, 2026

Warning

Rate limit exceeded

@danciaclara has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 11 minutes and 56 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 11 minutes and 56 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: fe7e81b2-ae2d-4582-b737-d8e2e169609f

📥 Commits

Reviewing files that changed from the base of the PR and between 3688496 and b37d96d.

📒 Files selected for processing (5)
  • docs/self-hosting/manage/update-plane/airgapped-edition/update-airgapped-docker.md
  • docs/self-hosting/manage/update-plane/airgapped-edition/update-airgapped-kubernetes.md
  • docs/self-hosting/methods/airgapped-edition-kubernetes.md
  • docs/self-hosting/methods/airgapped-edition.md
  • docs/self-hosting/methods/airgapped-requirements.md
📝 Walkthrough

Walkthrough

Adds Airgapped Edition docs and updates navigation: introduces two new upgrade guides (Docker and Kubernetes), adds a collapsed "Airgapped Edition" submenu under Self-hosting → Manage → Update Plane, and revises airgapped eligibility/badge and deployment-methods content across methods/requirements pages.

Changes

Cohort / File(s) Summary
VitePress Navigation Config
docs/.vitepress/config.mts
Renamed install submenu labels to “On Docker” / “On Kubernetes” and added a collapsed Airgapped Edition subgroup under Self-hosting → Manage → Update Plane linking to the new Docker and Kubernetes update pages.
Airgapped Upgrade Guides
docs/self-hosting/manage/update-plane/airgapped-edition/update-airgapped-docker.md, docs/self-hosting/manage/update-plane/airgapped-edition/update-airgapped-kubernetes.md
Added two new pages with step-by-step upgrade procedures: Docker guide (push images to internal registry, transfer compose/env, activate license, restart, verify) and Kubernetes guide (push images, fetch Helm chart, merge values, set planeVersion, redeploy, verify).
Airgapped Methods & Requirements
docs/self-hosting/methods/airgapped-edition.md, docs/self-hosting/methods/airgapped-edition-kubernetes.md, docs/self-hosting/methods/airgapped-requirements.md
Updated badges and eligibility wording to reference “Enterprise Grid” and a 100-seat minimum; rewrote info callouts and added a “Deployment methods” section with CardGroup links to Docker and Kubernetes airgapped docs.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 I hopped through pages, tidy and fleet,

New airgapped paths beneath my feet.
Docker and Helm in neat little stacks,
I left a trail of doc-shaped snacks.
Hop on — updates now have their tracks 🥕

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'Update Airgapped Edition' is vague and generic, using the non-descriptive term 'Update' that does not convey the specific nature of the changes made. Provide a more specific title that captures the main change, such as 'Add airgapped upgrade guides for Docker and Kubernetes' or 'Update airgapped deployment documentation with upgrade procedures.'
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ 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 update-airgapped-edition

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.

Actionable comments posted: 2

🤖 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/manage/update-plane/airgapped-edition/update-airgapped-docker.md`:
- Around line 1-4: The frontmatter for the markdown page is missing the required
keywords field; update the YAML frontmatter (the block containing title and
description in the file) to include a keywords property (e.g., keywords:
["airgapped", "docker", "upgrade", "plane"]) so the page conforms to
docs/**/*.md guidelines; ensure the keywords line is added inside the existing
--- frontmatter block alongside title and description and formatted as a YAML
list or comma-separated string.

In
`@docs/self-hosting/manage/update-plane/airgapped-edition/update-airgapped-kubernetes.md`:
- Around line 1-4: The frontmatter for the Markdown page is missing the required
keywords field; update the YAML frontmatter at the top of the file (the block
containing title and description) to include a keywords key with an array or
comma-separated list of relevant terms (e.g., keywords: ["airgapped", "upgrade",
"kubernetes"]) so the frontmatter contains title, description, and keywords as
required.
🪄 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: f14e7600-92f3-45ad-899c-31bcf35e5ae5

📥 Commits

Reviewing files that changed from the base of the PR and between 9ea2d66 and 7c319b9.

📒 Files selected for processing (3)
  • docs/.vitepress/config.mts
  • docs/self-hosting/manage/update-plane/airgapped-edition/update-airgapped-docker.md
  • docs/self-hosting/manage/update-plane/airgapped-edition/update-airgapped-kubernetes.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: 2

♻️ Duplicate comments (2)
docs/self-hosting/manage/update-plane/airgapped-edition/update-airgapped-docker.md (1)

1-4: ⚠️ Potential issue | 🟠 Major

Add required keywords to frontmatter.

This page frontmatter is missing keywords, which is required for docs pages.

💡 Proposed fix
 ---
 title: Upgrade Airgapped Edition (Docker)
 description: Upgrade your airgapped Plane instance running on Docker by cloning images, replacing configuration files, and uploading a new license.
+keywords: airgapped, docker, upgrade, self-hosting, plane
 ---

As per coding guidelines: docs/**/*.md: 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/manage/update-plane/airgapped-edition/update-airgapped-docker.md`
around lines 1 - 4, The page frontmatter is missing the required YAML key
"keywords"; update the frontmatter at the top of the file (where "title" and
"description" are declared) to add a "keywords:" entry containing an array or
comma-separated list of relevant keywords (e.g., keywords: ["airgapped",
"docker", "upgrade"]) so the frontmatter includes title, description, and
keywords; ensure the new "keywords" key follows the existing frontmatter format
exactly.
docs/self-hosting/manage/update-plane/airgapped-edition/update-airgapped-kubernetes.md (1)

1-4: ⚠️ Potential issue | 🟠 Major

Frontmatter is incomplete: missing keywords.

Please add keywords so this page matches required docs frontmatter schema.

💡 Proposed fix
 ---
 title: Upgrade Airgapped Edition on Kubernetes
 description: Upgrade your airgapped Plane instance running on Kubernetes by cloning images, updating the Helm chart, and redeploying.
+keywords: airgapped, kubernetes, helm, upgrade, self-hosting, plane
 ---

As per coding guidelines: docs/**/*.md: 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/manage/update-plane/airgapped-edition/update-airgapped-kubernetes.md`
around lines 1 - 4, The frontmatter at the top of the Markdown (the YAML block
containing title and description) is missing the required keywords field; update
the frontmatter in the "Upgrade Airgapped Edition on Kubernetes" page by adding
a keywords key with an array of relevant terms (e.g., ["airgapped",
"kubernetes", "upgrade", "plane"]) so the frontmatter contains title,
description, and keywords and conforms to the docs schema.
🧹 Nitpick comments (1)
docs/self-hosting/manage/update-plane/airgapped-edition/update-airgapped-kubernetes.md (1)

50-52: Consider adding the concrete Helm redeploy command.

Step 4 says to redeploy but doesn’t include the actual command, which makes the update flow less actionable.

💡 Suggested addition
 4. Once the Helm chart and `values.yaml` file are updated, redeploy the Helm release in your Kubernetes cluster to complete the update.
+
+   ```bash
+   helm upgrade plane-app plane-enterprise-<chart_version>.tgz \
+     --install \
+     --namespace plane \
+     -f values.yaml \
+     --wait
+   ```
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In
`@docs/self-hosting/manage/update-plane/airgapped-edition/update-airgapped-kubernetes.md`
around lines 50 - 52, Add a concrete Helm redeploy command to Step 4 so users
can follow the update flow; insert a ready-to-run example using the helm upgrade
invocation referencing the release name and chart (e.g., helm upgrade plane-app
plane-enterprise-<chart_version>.tgz --install --namespace plane -f values.yaml
--wait) and ensure the command is placed immediately after the sentence that
instructs to "redeploy the Helm release" and before "Verify the upgrade by
checking the version in your Plane application."
🤖 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/methods/airgapped-edition-kubernetes.md`:
- Line 10: The info callout contains a duplicated word "for for" in the sentence
starting "Airgapped deployments are available exclusively for for Enterprise
Grid..."; edit that sentence to remove the extra "for" so it reads "...available
exclusively for Enterprise Grid customers..." and ensure the surrounding
punctuation and link to the sales email remain unchanged.

In `@docs/self-hosting/methods/airgapped-edition.md`:
- Line 10: The eligibility sentence contains a duplicated word "for" in the
airgapped notice; update the string "Airgapped deployments are available
exclusively for for Enterprise Grid customers with a minimum commitment of 100
seats." to remove the extra "for" so it reads "...available exclusively for
Enterprise Grid customers..." (locate and edit the line containing that exact
sentence in the airgapped-edition.md content).

---

Duplicate comments:
In
`@docs/self-hosting/manage/update-plane/airgapped-edition/update-airgapped-docker.md`:
- Around line 1-4: The page frontmatter is missing the required YAML key
"keywords"; update the frontmatter at the top of the file (where "title" and
"description" are declared) to add a "keywords:" entry containing an array or
comma-separated list of relevant keywords (e.g., keywords: ["airgapped",
"docker", "upgrade"]) so the frontmatter includes title, description, and
keywords; ensure the new "keywords" key follows the existing frontmatter format
exactly.

In
`@docs/self-hosting/manage/update-plane/airgapped-edition/update-airgapped-kubernetes.md`:
- Around line 1-4: The frontmatter at the top of the Markdown (the YAML block
containing title and description) is missing the required keywords field; update
the frontmatter in the "Upgrade Airgapped Edition on Kubernetes" page by adding
a keywords key with an array of relevant terms (e.g., ["airgapped",
"kubernetes", "upgrade", "plane"]) so the frontmatter contains title,
description, and keywords and conforms to the docs schema.

---

Nitpick comments:
In
`@docs/self-hosting/manage/update-plane/airgapped-edition/update-airgapped-kubernetes.md`:
- Around line 50-52: Add a concrete Helm redeploy command to Step 4 so users can
follow the update flow; insert a ready-to-run example using the helm upgrade
invocation referencing the release name and chart (e.g., helm upgrade plane-app
plane-enterprise-<chart_version>.tgz --install --namespace plane -f values.yaml
--wait) and ensure the command is placed immediately after the sentence that
instructs to "redeploy the Helm release" and before "Verify the upgrade by
checking the version in your Plane application."
🪄 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: 5245084c-7941-4ed1-87ec-8e0ad966f285

📥 Commits

Reviewing files that changed from the base of the PR and between c60abfb and 3688496.

📒 Files selected for processing (6)
  • docs/.vitepress/config.mts
  • docs/self-hosting/manage/update-plane/airgapped-edition/update-airgapped-docker.md
  • docs/self-hosting/manage/update-plane/airgapped-edition/update-airgapped-kubernetes.md
  • docs/self-hosting/methods/airgapped-edition-kubernetes.md
  • docs/self-hosting/methods/airgapped-edition.md
  • docs/self-hosting/methods/airgapped-requirements.md
🚧 Files skipped from review as they are similar to previous changes (2)
  • docs/self-hosting/methods/airgapped-requirements.md
  • docs/.vitepress/config.mts

@danciaclara danciaclara merged commit 38c3e4a into master Apr 1, 2026
8 checks passed
@danciaclara danciaclara deleted the update-airgapped-edition branch April 1, 2026 12:14
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