Skip to content

Split TOML reference docs by role#448

Merged
NipunaRanasinghe merged 3 commits into
wso2:mainfrom
NipunaRanasinghe:config-fixes
May 14, 2026
Merged

Split TOML reference docs by role#448
NipunaRanasinghe merged 3 commits into
wso2:mainfrom
NipunaRanasinghe:config-fixes

Conversation

@NipunaRanasinghe

@NipunaRanasinghe NipunaRanasinghe commented May 14, 2026

Copy link
Copy Markdown
Contributor

Purpose

  • Move Ballerina.toml and Cloud.toml references out of Reference > Configuration into a new Reference > Project sibling category. The previous grouping conflated runtime configuration (Config.toml, configuration-management) with package-root descriptors (Ballerina.toml, Cloud.toml) — these are different concerns and readers look them up differently.
  • Rewrite the "What's next" section on each TOML reference to match the reader's actual next step under the new IA. Cloud.toml now points forward to Docker and Kubernetes; Ballerina.toml points to run-locally; Config.toml points to configuration-management.
  • Fix a pre-existing broken [Connections](managing-connections.md) link in configuration-management.md.
  • Cross-link docker.md, kubernetes.md, and openshift.md to the relocated Cloud.toml reference at the first descriptive mention of the file.
  • Normalize the cross-section links introduced in this PR to absolute paths without .md (e.g.
    /docs/reference/project/cloudtoml-reference), matching the dominant pattern used elsewhere for cross-section navigation.

Goals

Describe the solutions that this feature/fix will introduce to resolve the problems described above

Approach

Describe how you are implementing the solutions. Include an animated GIF or screenshot if the change affects the UI (email documentation@wso2.com to review all UI text). Include a link to a Markdown file or Google doc if the feature write-up is too long to paste here.

User stories

Summary of user stories addressed by this change>

Release note

Brief description of the new feature or bug fix as it will appear in the release notes

Documentation

Link(s) to product documentation that addresses the changes of this PR. If no doc impact, enter �N/A� plus brief explanation of why there�s no doc impact

Training

Link to the PR for changes to the training content in https://github.com/wso2/WSO2-Training, if applicable

Certification

Type �Sent� when you have provided new/updated certification questions, plus four answers for each question (correct answer highlighted in bold), based on this change. Certification questions/answers should be sent to certification@wso2.com and NOT pasted in this PR. If there is no impact on certification exams, type �N/A� and explain why.

Marketing

Link to drafts of marketing content that will describe and promote this feature, including product page changes, technical articles, blog posts, videos, etc., if applicable

Automation tests

  • Unit tests

    Code coverage information

  • Integration tests

    Details about the test cases and coverage

Security checks

Samples

Provide high-level details about the samples related to this feature

Related PRs

List any other related PRs

Migrations (if applicable)

Describe migration steps and platforms on which migration has been tested

Test environment

List all JDK versions, operating systems, databases, and browser/versions on which this feature/fix was tested

Learning

Describe the research phase and any blog posts, patterns, libraries, or add-ons you used to solve the problem.

Summary by CodeRabbit

  • Documentation
    • Clarified that all Cloud.toml configuration fields are optional, with compiler-inferred defaults.
    • Improved cross-references and navigation between deployment and configuration documentation pages.
    • Reorganized documentation structure for better discoverability of configuration references.

Review Change Stack

@coderabbitai

coderabbitai Bot commented May 14, 2026

Copy link
Copy Markdown
Contributor

Warning

Rate limit exceeded

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

You’ve run out of usage credits. Purchase more in the billing tab.

⌛ 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: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 43b0f37b-5100-4f8b-a165-32b57886479b

📥 Commits

Reviewing files that changed from the base of the PR and between d016ee4 and 7eeae9d.

📒 Files selected for processing (3)
  • en/docs/reference/config/configtoml-reference.md
  • en/docs/reference/config/configuration-management.md
  • en/docs/reference/project/ballerinatoml-reference.md
✨ 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.

@NipunaRanasinghe NipunaRanasinghe marked this pull request as ready for review May 14, 2026 19:42

@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

🤖 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/reference/project/ballerinatoml-reference.md`:
- Line 233: Replace the relative link target "cloudtoml-reference.md" in the
list item that starts with "[Cloud.toml reference]" with the normalized absolute
path "/docs/reference/project/cloudtoml-reference" (remove the .md extension) so
it matches the PR's absolute-link convention; update the link target in the
markdown line containing the "Cloud.toml reference" text accordingly.
🪄 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: 0201b3fb-ca60-4f49-9ae6-95cecbd40527

📥 Commits

Reviewing files that changed from the base of the PR and between e0142eb and d016ee4.

📒 Files selected for processing (8)
  • en/docs/deploy/self-hosted/docker.md
  • en/docs/deploy/self-hosted/kubernetes.md
  • en/docs/deploy/self-hosted/openshift.md
  • en/docs/reference/config/configtoml-reference.md
  • en/docs/reference/project/ballerinatoml-reference.md
  • en/docs/reference/project/cloudtoml-reference.md
  • en/docs/reference/reference.md
  • en/sidebars.ts

Comment thread en/docs/reference/project/ballerinatoml-reference.md Outdated
@NipunaRanasinghe NipunaRanasinghe merged commit ff5ae3b into wso2:main May 14, 2026
3 checks passed
@coderabbitai coderabbitai Bot mentioned this pull request May 18, 2026
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