Skip to content

Add containerized deployment content#518

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

Add containerized deployment content#518
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
    • Consolidated Docker, Kubernetes, and OpenShift deployment guides into a single "Containerized Deployment" page covering Code to Cloud workflows for all three platforms
    • Replaced multiple platform-specific links with the new consolidated guide across Deploy, Self-Hosted, overview, FAQ, IDE views, and config references
    • Simplified sidebar and navigation for easier discoverability of containerized deployment guidance

@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: 78484c4d-3690-454d-a645-c3c2b3fc9b01

📥 Commits

Reviewing files that changed from the base of the PR and between dc8348b and e6bd027.

📒 Files selected for processing (2)
  • en/docs/deploy/self-hosted/containerized-deployment.md
  • en/docs/reference/appendix/faq.md
✅ Files skipped from review due to trivial changes (2)
  • en/docs/reference/appendix/faq.md
  • en/docs/deploy/self-hosted/containerized-deployment.md

📝 Walkthrough

Walkthrough

This PR consolidates container deployment docs into a single "Containerized Deployment" guide covering Docker, Kubernetes, and OpenShift, updates navigation and sidebar entries to point to it, and removes the separate platform-specific links.

Changes

Container Deployment Documentation Consolidation

Layer / File(s) Summary
New unified containerized deployment guide
en/docs/deploy/self-hosted/containerized-deployment.md
Introduces a consolidated guide for Ballerina Code to Cloud deployments covering Docker, Kubernetes, and Red Hat OpenShift: prerequisites, artifact generation, Cloud.toml/Config.toml behavior, platform-specific build/apply/push workflows, probe configuration, ConfigMap mounting, service exposure, and verification.
Deployment overview consolidation
en/docs/deploy/overview.md
Replaces separate Docker/Kubernetes/OpenShift bullets with a single "Containerized Deployment" entry in the deployment options list.
Cross-document link updates
en/docs/deploy-operate/deploy/graalvm-native-images.md, en/docs/deploy-operate/deploy/managing-configurations.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/appendix/faq.md, en/docs/reference/project/cloudtoml-reference.md
Updates "What's next" lists and deployment option links across multiple docs to reference the new Containerized Deployment guide instead of the former separate platform pages.
Sidebar configuration update
en/sidebars.ts
Replaces the Deploy → Self-Hosted entries for docker/kubernetes/openshift with a single deploy/self-hosted/containerized-deployment sidebar item.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

  • wso2/docs-integrator#387: Modifies IDE deployment/navigation docs (integration-view and project-view) to update deployment option labels/links; overlaps with this PR's view updates.
  • wso2/docs-integrator#448: Touches self-hosted docker/kubernetes/openshift docs and cross-linking to Cloud.toml; related to the consolidated containerized-deployment doc.

Suggested reviewers

  • rosensilva
  • anupama-pathirage
  • KavinduZoysa
  • NipunaRanasinghe

Poem

🐰 I hopped through docs both near and far,
Merged Docker, K8s, OpenShift in one jar,
One container guide now leads the way,
Clearer steps for each deployment day,
🎉 — a rabbit's tidy doc bouquet

🚥 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 template placeholder '$subject' instead of providing actual purpose, goals, approach, or other required documentation sections. Replace placeholder with substantive content following the template: describe the purpose (why consolidate docs), goals, approach, user stories, release notes, and documentation/testing details.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title 'Add containerized deployment content' accurately describes the main change—consolidating Docker, Kubernetes, and OpenShift documentation into a new unified containerized deployment guide.
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: 2

🤖 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/containerized-deployment.md`:
- Line 11: Change all non-H1 headings in containerized-deployment.md to sentence
case: e.g., update the H2 "Supported Platforms" to "Supported platforms" and
similarly convert the other non-H1 headings referenced (lines ~49, ~150, ~324)
from Title Case to sentence case; ensure only H1s remain Title Case and preserve
existing heading levels and punctuation.

In `@en/docs/reference/appendix/faq.md`:
- Line 112: Update the link text so its visible label matches the target page's
primary keywords: change the markdown reference "See [Deploy and
Operate](../../deploy/self-hosted/containerized-deployment.md) for detailed
deployment guides." to use "Containerized Deployment" as the link text (e.g.,
"See [Containerized
Deployment](../../deploy/self-hosted/containerized-deployment.md) ...");
alternatively, if you intended to point to the Deploy overview page, swap the
URL to that overview and keep link text accordingly—make sure the link label and
the target file (containerized-deployment.md or the Deploy overview) share the
same primary keywords.
🪄 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: 4cbd278b-b7ad-4245-a136-f1f1a6b9a7d9

📥 Commits

Reviewing files that changed from the base of the PR and between 84d5ae1 and dc8348b.

📒 Files selected for processing (13)
  • en/docs/deploy-operate/deploy/graalvm-native-images.md
  • en/docs/deploy-operate/deploy/managing-configurations.md
  • en/docs/deploy/overview.md
  • en/docs/deploy/self-hosted/containerized-deployment.md
  • en/docs/deploy/self-hosted/docker.md
  • en/docs/deploy/self-hosted/kubernetes.md
  • en/docs/deploy/self-hosted/openshift.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/appendix/faq.md
  • en/docs/reference/project/cloudtoml-reference.md
  • en/sidebars.ts
💤 Files with no reviewable changes (3)
  • en/docs/deploy/self-hosted/openshift.md
  • en/docs/deploy/self-hosted/docker.md
  • en/docs/deploy/self-hosted/kubernetes.md

Comment thread en/docs/deploy/self-hosted/containerized-deployment.md Outdated
Comment thread en/docs/reference/appendix/faq.md Outdated
@Dilhasha Dilhasha merged commit 60938b1 into wso2:main Jun 4, 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.

2 participants