Skip to content

Fix/k8s-improvements#11404

Merged
Krishanx92 merged 5 commits into
wso2:masterfrom
Saadha123:fix/k8s-review-docs
May 22, 2026
Merged

Fix/k8s-improvements#11404
Krishanx92 merged 5 commits into
wso2:masterfrom
Saadha123:fix/k8s-review-docs

Conversation

@Saadha123
Copy link
Copy Markdown
Contributor

Purpose

Improved docs based on feedback received

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 22, 2026

Review Change Stack

📝 Walkthrough

Summary

This pull request updates Kubernetes deployment documentation across six pattern setup guides with platform-specific improvements and clarifications.

Changes

Windows Compatibility Enhancements

  • Added Windows-specific instructions for generating encryption keys using PowerShell as an alternative to the openssl command
  • Included Windows hosts file editing guidance with notes about file location and admin privilege requirements

Clarity and Timing Notes

  • Added clarifications that deployments and pod readiness may take longer on initial runs
  • Introduced introductory sentences directing readers to detailed steps in subsequent sections

Documentation Restructuring

  • Renamed "Additional Configuration" sections to "Customized Configurations" across all files
  • Updated associated instructional text to reference deployment via "Deploy with Custom Values"

Files Updated

  • am-pattern-0-all-in-one.md
  • am-pattern-1-all-in-one-ha.md
  • am-pattern-2-all-in-one-gw.md
  • am-pattern-3-acp-tm-gw.md
  • am-pattern-4-acp-tm-gw-km.md
  • am-pattern-5-all-in-one-gw-km.md
  • am-pattern-6-all-in-one-is-as-km.md

Impact: Documentation-only changes with approximately 16-18 lines added and 3-4 lines removed per file. These updates improve usability for Windows users and clarify deployment expectations across all Kubernetes deployment patterns.

Walkthrough

This pull request adds comprehensive Windows-specific guidance to six Kubernetes deployment pattern documentation files. The changes include PowerShell-based encryption key generation alternatives for environments where openssl is unavailable, Windows hosts file editing instructions with administrative requirements, and clarifications that pod startup may take longer on first run. Additionally, the "Additional Configuration" section heading is consistently renamed to "Customized Configurations" with updated deployment workflow references across all patterns.

Suggested reviewers

  • chamilaadhi
  • tharikaGitHub
  • Krishanx92
🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name Status Explanation Resolution
Description check ⚠️ Warning The PR description is largely incomplete, providing only a single sentence ('Improved docs based on feedback received') without addressing any of the required template sections. Complete the PR description template with at least Purpose, Goals, Approach, Release note, and Documentation sections to provide sufficient context for reviewers.
Title check ❓ Inconclusive The title 'Fix/k8s-improvements' is vague and does not clearly convey the specific changes made across six Kubernetes documentation files. Use a more descriptive title that summarizes the main changes, such as 'Add Windows-specific guidance and clarifications to Kubernetes deployment documentation'.
✅ Passed checks (3 passed)
Check name Status Explanation
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.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

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/install-and-setup/setup/kubernetes-deployment/kubernetes/am-pattern-0-all-in-one.md`:
- Around line 408-410: The `!!! note` admonition in the encryption-key step is
under-indented so it may not render inside the numbered list; locate the
encryption-key step block containing the `!!! note` token and adjust its leading
spaces to match the indentation of the other lines in that list item (so the
`!!! note` is aligned with the surrounding paragraph/content of the step)
ensuring the admonition is nested correctly under the list.
🪄 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: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: b1cba568-d782-418f-9668-e71254b9aa07

📥 Commits

Reviewing files that changed from the base of the PR and between 08582df and 602570f.

📒 Files selected for processing (7)
  • en/docs/install-and-setup/setup/kubernetes-deployment/kubernetes/am-pattern-0-all-in-one.md
  • en/docs/install-and-setup/setup/kubernetes-deployment/kubernetes/am-pattern-1-all-in-one-ha.md
  • en/docs/install-and-setup/setup/kubernetes-deployment/kubernetes/am-pattern-2-all-in-one-gw.md
  • en/docs/install-and-setup/setup/kubernetes-deployment/kubernetes/am-pattern-3-acp-tm-gw.md
  • en/docs/install-and-setup/setup/kubernetes-deployment/kubernetes/am-pattern-4-acp-tm-gw-km.md
  • en/docs/install-and-setup/setup/kubernetes-deployment/kubernetes/am-pattern-5-all-in-one-gw-km.md
  • en/docs/install-and-setup/setup/kubernetes-deployment/kubernetes/am-pattern-6-all-in-one-is-as-km.md

Comment on lines +408 to +410
!!! note
`openssl` is not available on Windows by default. Windows users can generate the key using PowerShell's `System.Security.Cryptography.RandomNumberGenerator` class.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Fix admonition indentation in the encryption-key step.

!!! note appears under-indented at Line 408, which can prevent the note from rendering as part of the numbered step. Align it with the surrounding block indentation for this list item.

🤖 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/install-and-setup/setup/kubernetes-deployment/kubernetes/am-pattern-0-all-in-one.md`
around lines 408 - 410, The `!!! note` admonition in the encryption-key step is
under-indented so it may not render inside the numbered list; locate the
encryption-key step block containing the `!!! note` token and adjust its leading
spaces to match the indentation of the other lines in that list item (so the
`!!! note` is aligned with the surrounding paragraph/content of the step)
ensuring the admonition is nested correctly under the list.

@Krishanx92 Krishanx92 merged commit fdbdbbe into wso2:master May 22, 2026
2 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