Fix incorrect terminal commands in API Platform Documentation - #385
Fix incorrect terminal commands in API Platform Documentation#385VidathVi wants to merge 3 commits into
Conversation
…d missing port forwarding and clarified conflicitng TLS configuration instructions
📝 WalkthroughWalkthroughThe Kubernetes standalone deployment guide updates Helm instructions, changes the controller health check to authenticated port 9090, and adds gateway runtime service port-forwarding steps for data-plane testing. ChangesKubernetes standalone documentation
Estimated code review effort: 1 (Trivial) | ~5 minutes 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✨ 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
🤖 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/api-gateway/1.1.0/deployment/deployment-modes/kubernetes/kubernetes-standalone.md`:
- Around line 267-273: Update the “Expose the data plane” section by adding the
required blank line between the heading and the opening fenced code block,
preserving the existing commands and documentation content.
🪄 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: ASSERTIVE
Plan: Pro Plus
Run ID: af9ec961-d9d0-46df-b0ad-28d88a49ab4e
📒 Files selected for processing (1)
en/docs/api-gateway/1.1.0/deployment/deployment-modes/kubernetes/kubernetes-standalone.md
|
Hope these changes I suggested are useful. Let me know if something needs changing. |
Purpose
Found four issues in the kubernetes standalone gateway deployment guide (https://wso2.com/api-platform/docs/api-gateway/1.1.0/deployment/deployment-modes/kubernetes/kubernetes-standalone/) while following the page's instructions on a local "kind" cluster and fixed them.
Checklist
llms.txtunaffectedGoals
Make sure documented commands work exactly as written for anyone following the guide from scratch on a local development cluster, without running into errors in the terminal.
Approach
Fixed four command line commands in
helm upgradeif running sequentially).User stories
As a developer following this guide for the first time, it would be nice to have all the docummented commands work as written. This would save the time wasted on figuring out and fixing these issues.
Release note
Fixed incorrect port, missing authentication, a missing port-forward step,
and conflicting install/TLS instructions in the Kubernetes standalone
gateway deployment guide.
Documentation
N/A — this PR is the documentation fix itself.
Training
N/A — no impact on WSO2-Training content.
Certification
N/A — no impact on certification exam content.
Marketing
N/A — small internal doc correction, no marketing surface.
Automation tests
Security checks
Samples
N/A
Related PRs
None
Migrations (if applicable)
N/A
Test environment
Windows 11, local
kindKubernetes cluster,kubectl, Helm 3.x,gateway Helm chart
gateway-1.1.5(app.kubernetes.io/version: 1.1.0),cert-manager (Jetstack) for TLS. All four fixes verified by reproducing
the original failures, then confirming the corrected commands succeed.
Learning
Every issue was found by hitting an actual command line failure while working on a personal project while following the WSO2 kubernetes standalone gateway guide step by step. And then inspecting cluster states to find the fix