Skip to content

Add local and vm deployment content#519

Merged
Dilhasha merged 2 commits into
wso2:mainfrom
Dilhasha:docs-updates
Jun 5, 2026
Merged

Add local and vm deployment content#519
Dilhasha merged 2 commits into
wso2:mainfrom
Dilhasha:docs-updates

Conversation

@Dilhasha

@Dilhasha Dilhasha commented Jun 4, 2026

Copy link
Copy Markdown
Contributor

Purpose

$subject

Summary by CodeRabbit

  • Documentation
    • Added a unified "Local and VM deployment" guide covering local development, executable JAR deployment on VMs, consolidated package deployment, runtime config examples, JVM tuning, and health checks.
    • Removed the standalone "Run Locally" and old VM-based pages; updated navigation, sidebars, and in-doc links/tables to point to the new consolidated guide.

@coderabbitai

coderabbitai Bot commented Jun 4, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 41fd6ced-4f16-4364-84b7-21708d568d92

📥 Commits

Reviewing files that changed from the base of the PR and between 5c048a8 and 0d9d5f9.

📒 Files selected for processing (1)
  • en/docs/deploy/self-hosted/local-and-vm-deployment.md
✅ Files skipped from review due to trivial changes (1)
  • en/docs/deploy/self-hosted/local-and-vm-deployment.md

📝 Walkthrough

Walkthrough

This PR consolidates WSO2 Integrator deployment documentation by merging separate local and VM deployment guides into one comprehensive page, then updates all cross-document links and sidebar navigation to reference the new unified location.

Changes

Consolidate local and VM deployment documentation

Layer / File(s) Summary
New consolidated local and VM deployment guide
en/docs/deploy/self-hosted/local-and-vm-deployment.md
Creates a single comprehensive guide covering local execution with bal run, remote VM deployment from source, JAR-based production deployment with bal build, consolidated multi-integration packaging, JVM tuning recommendations, log management configuration, health endpoint setup, and next-step documentation links.
Update navigation links and sidebar references
en/docs/deploy-operate/deploy/aws-azure-gcp.md, en/docs/deploy-operate/deploy/graalvm-native-images.md, en/docs/deploy/overview.md, en/docs/develop/understand-ide/views/integration-view.md, en/docs/develop/understand-ide/views/project-view.md, en/docs/reference/project/ballerinatoml-reference.md, en/sidebars.ts
Updates all "What's next" links, deployment option tables, and sidebar entries to point to the new consolidated local-and-vm-deployment page, removing the separate run-locally and legacy vm-based-deployment references.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 Two guides hop close and stitch a seam,
One path now guides both local and VM dream,
Links updated, sidebars neat and spry,
Docs aligned beneath the same bright sky,
A little rabbit cheers: deployment, unify!

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The PR description is incomplete, containing only a Purpose section with a template placeholder ($subject) instead of actual content required by the repository template. Replace the placeholder with a detailed purpose statement explaining the consolidation rationale, and complete all other required template sections including Goals, Approach, User stories, Release note, and Documentation.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: adding consolidated local and VM deployment documentation by combining and reorganizing existing deployment guides.
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

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (1)
en/docs/deploy/self-hosted/local-and-vm-deployment.md (1)

2-2: 🏗️ Heavy lift

Align the new page slug with URL optimization and hierarchy rules.

local-and-vm-deployment is not optimized per the URL guideline (contains filler word and and repeats deployment context under /deploy/). Consider renaming to a shorter slug such as local-vm or local-vm-deploy, then update references in this PR.

As per coding guidelines: URLs should be shorter than titles, remove filler words, and avoid redundant keywords already implied by parent hierarchy.

🤖 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 `@en/docs/deploy/self-hosted/local-and-vm-deployment.md` at line 2, The page
slug "local-and-vm-deployment" is verbose and repeats the parent "/deploy/";
rename the file/slug to a concise form (e.g., "local-vm" or "local-vm-deploy")
and update all references in this PR (frontmatter title/slug in the markdown,
any internal links, TOC entries, and sidebar/nav config) so URLs follow the
guideline; ensure the frontmatter line that currently reads title: Local and VM
Deployment keeps the human-readable title but the file name and any slug fields
use the chosen shorter slug (e.g., local-vm).
🤖 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 `@en/docs/deploy/self-hosted/local-and-vm-deployment.md`:
- Around line 95-99: The fenced code block showing the directory snippet (lines
starting with "target/", "bin/", "my_integration.jar") is missing a language
identifier and triggers MD040; update that fenced block to include the bash
language marker (i.e., change ``` to ```bash) so Prism will highlight it
correctly and satisfy the linter rule.

---

Nitpick comments:
In `@en/docs/deploy/self-hosted/local-and-vm-deployment.md`:
- Line 2: The page slug "local-and-vm-deployment" is verbose and repeats the
parent "/deploy/"; rename the file/slug to a concise form (e.g., "local-vm" or
"local-vm-deploy") and update all references in this PR (frontmatter title/slug
in the markdown, any internal links, TOC entries, and sidebar/nav config) so
URLs follow the guideline; ensure the frontmatter line that currently reads
title: Local and VM Deployment keeps the human-readable title but the file name
and any slug fields use the chosen shorter slug (e.g., local-vm).
🪄 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: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: e26aae25-a0a5-40c9-ba5b-9d33c3bb1448

📥 Commits

Reviewing files that changed from the base of the PR and between 60938b1 and 5c048a8.

📒 Files selected for processing (10)
  • en/docs/deploy-operate/deploy/aws-azure-gcp.md
  • en/docs/deploy-operate/deploy/graalvm-native-images.md
  • en/docs/deploy-operate/deploy/vm-based-deployment.md
  • en/docs/deploy/overview.md
  • en/docs/deploy/self-hosted/local-and-vm-deployment.md
  • en/docs/deploy/self-hosted/run-locally.md
  • en/docs/develop/understand-ide/views/integration-view.md
  • en/docs/develop/understand-ide/views/project-view.md
  • en/docs/reference/project/ballerinatoml-reference.md
  • en/sidebars.ts
💤 Files with no reviewable changes (2)
  • en/docs/deploy/self-hosted/run-locally.md
  • en/docs/deploy-operate/deploy/vm-based-deployment.md

Comment thread en/docs/deploy/self-hosted/local-and-vm-deployment.md Outdated
@NipunaRanasinghe

Copy link
Copy Markdown
Contributor

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Jun 4, 2026

Copy link
Copy Markdown
Contributor
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@Dilhasha Dilhasha merged commit e0f4b5c into wso2:main Jun 5, 2026
3 checks passed
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.

3 participants