Added activate license stepped in all deployments

[danciaclara]

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

---

Note

Adds license activation step to all self-hosting deployment guides and reorganizes docs navigation (tab rename, grouped install methods) with minor copy updates.

• Documentation (self-hosting guides)
  • Add post-deployment step to activate license in self-hosting/methods/{coolify,docker-aio,docker-compose,docker-swarm,kubernetes,podman-quadlets,portainer}.mdx.
  • Minor wording/numbering and confirmation text tweaks.
• Navigation and structure (mint.json)
  • Rename tab to Build and extend (from Dev Tools).
  • Reorganize Install navigation:
    • New Docker group containing self-hosting/methods/{docker-compose,docker-aio,docker-swarm}.
    • Add self-hosting/methods/podman-quadlets at top level of Install.
    • New Managed platforms group for self-hosting/methods/{coolify,portainer}.
  • Update page title to Docker Compose in self-hosting/methods/docker-compose.mdx.

^{Written by Cursor Bugbot for commit e7b422a. This will update automatically on new commits. Configure here.}

Summary by CodeRabbit

Release Notes

• Documentation
  • Reorganized deployment methods into logical groupings (Docker and managed platforms) for improved navigation.
  • Renamed "Dev Tools" tab to "Build and extend."
  • Clarified Docker Compose documentation title for specificity.
  • Added consistent license activation guidance across all self-hosted deployment methods.
  • Enhanced documentation formatting and readability improvements.

[vercel]

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

Project	Deployment	Preview	Comments	Updated (UTC)
developer-docs	Error			Nov 10, 2025 3:20pm

[coderabbitai]

Walkthrough

Navigation structure in mint.json is reorganized by grouping deployment methods under "Docker" and "Managed platforms" categories, and the "Dev Tools" tab is renamed to "Build and extend". Across seven self-hosting deployment documentation files, license activation instructions are added as new steps, and upgrade tip blocks are removed and replaced with license activation guidance.

Changes

Cohort / File(s)	Summary
Navigation and tab structure mint.json	Tab label renamed from "Dev Tools" to "Build and extend". Three Docker-related pages grouped under "Docker" group. Coolify and Portainer pages grouped under "Managed platforms" group.
Deployment guides with license activation self-hosting/methods/coolify.mdx, self-hosting/methods/docker-aio.mdx, self-hosting/methods/docker-compose.mdx, self-hosting/methods/docker-swarm.mdx, self-hosting/methods/kubernetes.mdx, self-hosting/methods/podman-quadlets.mdx, self-hosting/methods/portainer.mdx	Consistent updates across all deployment methods: new final step added instructing users with paid plans to activate their license key. Removed existing upgrade tip blocks. Minor formatting and indentation adjustments. Docker-compose title updated to "Docker Compose".

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~15 minutes

• Repetitive pattern across seven documentation files (license activation step additions follow consistent structure)
• Straightforward navigation restructuring in mint.json with clear grouping logic
• All changes are content and formatting focused with no complex logic or structural dependencies

Poem

🐰 Tabs reorganized, documents aligned,
License keys brightened, deployment refined,
Docker and platforms grouped just so,
From Dev Tools to Build—watch clarity grow!
Seven guides updated, paid plans now seen,
Documentation's cleanest it's ever been! 🌟

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title contains a typo ('stepped' instead of 'step') and is partially related to the changeset but lacks clarity about the scope and nature of changes.	Consider revising to 'Add license activation steps to all deployment guides' or similar for clarity. Fix the typo and ensure the title accurately reflects that documentation was updated across multiple deployment methods.

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

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch activate-license

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 938da2a and e7b422a.

📒 Files selected for processing (8)

• mint.json (2 hunks)
• self-hosting/methods/coolify.mdx (1 hunks)
• self-hosting/methods/docker-aio.mdx (1 hunks)
• self-hosting/methods/docker-compose.mdx (2 hunks)
• self-hosting/methods/docker-swarm.mdx (1 hunks)
• self-hosting/methods/kubernetes.mdx (3 hunks)
• self-hosting/methods/podman-quadlets.mdx (1 hunks)
• self-hosting/methods/portainer.mdx (1 hunks)

🧰 Additional context used

🧠 Learnings (1)

📚 Learning: 2025-09-15T07:57:58.327Z

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.

Applied to files:

• self-hosting/methods/kubernetes.mdx

🔇 Additional comments (15)

self-hosting/methods/docker-aio.mdx (1)

97-99: License activation step added consistently across deployment guides.

The new step 4 clearly instructs users with paid plans to activate their license, with an appropriate link to the license management documentation. Placement after deployment completion is logical.

self-hosting/methods/podman-quadlets.mdx (1)

98-100: License activation step integrated consistently with startup sequence.

Step 6 logically follows the startup verification steps. The phrasing and link are consistent with license activation instructions across other deployment methods.

self-hosting/methods/docker-swarm.mdx (1)

59-61: License activation step properly added as final deployment step.

Step 5 is appropriately positioned after deployment completion. The hyperlink and wording align with license activation instructions across all self-hosting deployment methods.

self-hosting/methods/portainer.mdx (1)

55-57: License activation step added as final step with minor formatting improvement.

Step 8 includes the consistent license activation language and link. Indentation adjustment to step 7 improves readability of the completion statement.

self-hosting/methods/coolify.mdx (1)

46-48: License activation step properly added as final Coolify deployment step.

Step 9 maintains consistent language and link with other deployment guides. Reformatting of step 8's completion statement improves document flow.

self-hosting/methods/docker-compose.mdx (3)

1-8: Discrepancy between AI summary and provided code: Tip block status unclear.

The AI summary states "Removed content: The Tip block suggesting Plan upgrades," but the provided code still shows the Tip block at lines 6-8 without modification markers (~). Per the review guidelines, removed lines should not appear in the code. Please verify whether the Tip block was intended to be removed.

---

2-3: Title clarification improves navigation.

Changing the title from "Docker" to "Docker Compose" reduces ambiguity and aligns with the navigation restructuring in mint.json that groups Docker variants under a "Docker" category.

---

43-43: License activation step properly positioned as step 7.

Step 7 includes the standard license activation language and link, appropriately placed after the deployment completion confirmation at step 6.

self-hosting/methods/kubernetes.mdx (4)

7-9: Discrepancy: Tip block status conflicts with AI summary.

The AI summary states the Tip block was replaced with license activation guidance, but the code shows the Tip block at lines 7-9 unchanged (no ~ markers). Per guidelines, removed content should not appear in the code. Clarify whether removal was intended.

---

47-70: Formatting and indentation improvements enhance code example readability.

The various indentation adjustments throughout the Quick setup section (markdown list item indentation, code fence alignment, nested content) improve visual clarity without changing functional content. These align with documentation best practices for code blocks and nested structures.

---

80-105: Advanced setup formatting properly adjusted for nested documentation.

Indentation and formatting changes across the Advanced setup section (lines 80-105) improve consistency and readability. The bash snippet indentation and surrounding text alignment are enhanced without altering command logic or instructions.

---

106-106: License activation step 5 appropriately placed for Kubernetes deployments.

The new step 5 includes the consistent license activation link and language used across all deployment methods. Placement immediately after the helm install command (step 4) is logical and user-friendly.

mint.json (3)

54-54: Tab label change improves navigation clarity.

Renaming "Dev Tools" to "Build and extend" is more descriptive and user-friendly, better reflecting the section's content (building apps, webhooks, MCP integration). This improves discoverability and aligns with modern documentation UX patterns.

---

70-77: Docker deployment methods properly grouped for improved organization.

Consolidating docker-compose, docker-aio, and docker-swarm under a "Docker" group reduces navigation clutter and helps users quickly identify Docker-based deployment options. This organizational structure aligns with the deployment guide updates across these files.

---

87-93: Managed platforms group appropriately separates commercial deployment solutions.

The new "Managed platforms" group containing Coolify and Portainer clearly distinguishes these third-party platform-based deployment methods from containerization-native approaches (Docker, Kubernetes, Podman). This improves navigation clarity and helps users find appropriate deployment paths.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}