Update self-hosted section in deployment guide#520
Conversation
📝 WalkthroughWalkthroughThis PR consolidates deployment documentation by removing cloud provider–specific and environment-promotion guides, refactoring configuration variable naming and precedence rules, reframing VM deployment as a standalone option, and updating cross-document navigation links to reflect the simplified structure. ChangesDocumentation Consolidation and Configuration Refactoring
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 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 |
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
en/docs/deploy-operate/deploy/managing-configurations.md (1)
34-34:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winUse sentence case for non-H1 headings.
These headings are in title case/mixed case and should be sentence case per repo rules. Suggested updates:
## Per-environment config files### ConfigMap for non-sensitive values## Consolidated multi-service configuration
As per coding guidelines, “Use sentence case for all non-H1 titles (H2, H3, H4, etc.).”Also applies to: 280-280, 341-341
🤖 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-operate/deploy/managing-configurations.md` at line 34, Change the non-H1 headings from title case to sentence case: replace "Per-Environment config files" with "Per-environment config files", "ConfigMap for non-sensitive values" with "ConfigMap for non-sensitive values" (ensure only the first word and proper nouns are capitalized), and "Consolidated multi-service configuration" with "Consolidated multi-service configuration"; update any other H2/H3/H4 headings in the file that currently use title/mixed case to follow the repo rule of sentence case.Source: Coding guidelines
🤖 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-operate/deploy/managing-configurations.md`:
- Around line 17-20: The docs table wrongly groups `Config.toml` and
`BAL_CONFIG_DATA` as having equal precedence; update the table to split that row
into two separate rows (one for `Config.toml`/`BAL_CONFIG_FILES` and one for
`BAL_CONFIG_DATA`) and explicitly state that `BAL_CONFIG_DATA` overrides
`BAL_CONFIG_FILES`/`Config.toml` when both are present; reference the symbols
`BAL_CONFIG_DATA`, `BAL_CONFIG_FILES`, and `Config.toml` in the new rows and
adjust the precedence ordering text so it matches the repo's other docs.
---
Outside diff comments:
In `@en/docs/deploy-operate/deploy/managing-configurations.md`:
- Line 34: Change the non-H1 headings from title case to sentence case: replace
"Per-Environment config files" with "Per-environment config files", "ConfigMap
for non-sensitive values" with "ConfigMap for non-sensitive values" (ensure only
the first word and proper nouns are capitalized), and "Consolidated
multi-service configuration" with "Consolidated multi-service configuration";
update any other H2/H3/H4 headings in the file that currently use title/mixed
case to follow the repo rule of sentence case.
🪄 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: 67b7dc75-5000-4cb1-af58-67013acf74c2
📒 Files selected for processing (11)
en/docs/deploy-operate/deploy/aws-azure-gcp.mden/docs/deploy-operate/deploy/environments.mden/docs/deploy-operate/deploy/graalvm-native-images.mden/docs/deploy-operate/deploy/managing-configurations.mden/docs/deploy-operate/deploy/scaling-high-availability.mden/docs/deploy/overview.mden/docs/deploy/self-hosted/vm-deployment.mden/docs/develop/understand-ide/views/integration-view.mden/docs/develop/understand-ide/views/project-view.mden/docs/reference/project/ballerinatoml-reference.mden/sidebars.ts
💤 Files with no reviewable changes (3)
- en/docs/deploy-operate/deploy/scaling-high-availability.md
- en/docs/deploy-operate/deploy/environments.md
- en/docs/deploy-operate/deploy/aws-azure-gcp.md
Purpose
$subject
Summary by CodeRabbit