Skip to content

Fix incorrect terminal commands in API Platform Documentation - #385

Open
VidathVi wants to merge 3 commits into
wso2:mainfrom
VidathVi:fix-kuberenetes-standalone-gateway-docs
Open

Fix incorrect terminal commands in API Platform Documentation#385
VidathVi wants to merge 3 commits into
wso2:mainfrom
VidathVi:fix-kuberenetes-standalone-gateway-docs

Conversation

@VidathVi

Copy link
Copy Markdown

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

  • Not applicable — no new page created, llms.txt unaffected
  • Not applicable — no images added or changed
  • Not applicable — existing frontmatter unchanged

Goals

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

  1. Corrected the port of the health-check example from 9094 (which wasn't mapped) to 9090.
  2. Added the "-u admin:admin" flag to the same health check example because it doesn't work without this authentication. (It still doesn't work even with this authentication, but at least it gives a 404 page not found response instead of the terminal running into an error)
  3. Added a new "Expose the data plane" step before "Test routing through the gateway" step
  4. Added a note clarifying that the, "helm install" sections of "Install Gateway Chart" and "TLS Configuration" must be combined into a single install, because running them one after the other would lead to a release name conflict (or run via helm upgrade if 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

  • Unit tests: N/A — documentation-only change, no code.
  • Integration tests: N/A — documentation-only change, no code.

Security checks

  • Followed secure coding standards: N/A (no code changed)
  • Ran FindSecurityBugs plugin: N/A (no code changed)
  • Confirmed this PR doesn't commit any keys, passwords, tokens, usernames, or other secrets: Yes

Samples

N/A

Related PRs

None

Migrations (if applicable)

N/A

Test environment

Windows 11, local kind Kubernetes 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

…d missing port forwarding and clarified conflicitng TLS configuration instructions
@CLAassistant

CLAassistant commented Jul 31, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@coderabbitai

coderabbitai Bot commented Jul 31, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The 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.

Changes

Kubernetes standalone documentation

Layer / File(s) Summary
Helm upgrade guidance
en/docs/api-gateway/1.1.0/deployment/deployment-modes/kubernetes/kubernetes-standalone.md
The guide instructs users to use helm upgrade when the gateway is already installed.
Controller health check
en/docs/api-gateway/1.1.0/deployment/deployment-modes/kubernetes/kubernetes-standalone.md
The controller health check uses authenticated port 9090 instead of unauthenticated port 9094.
Runtime service testing
en/docs/api-gateway/1.1.0/deployment/deployment-modes/kubernetes/kubernetes-standalone.md
The guide adds commands to identify the gateway runtime service and port-forward HTTP 8080 and HTTPS 8443.

Estimated code review effort: 1 (Trivial) | ~5 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title is overly broad and does not clearly identify the primary fix. It mentions 'incorrect terminal commands' but the PR actually fixes four distinct issues including a port change, missing authentication, a missing step, and conflicting install instructions. Revise the title to be more specific about the main changes, such as 'Fix health check port, authentication, and Helm install instructions in Kubernetes deployment guide'.
✅ Passed checks (4 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.
Description check ✅ Passed The PR description is comprehensive and well-structured. It follows the template with all major sections completed, including detailed explanations of the four fixes, test environment verification, and clear reasoning for changes.
✨ 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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

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/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

📥 Commits

Reviewing files that changed from the base of the PR and between 43ae3ec and a150372.

📒 Files selected for processing (1)
  • en/docs/api-gateway/1.1.0/deployment/deployment-modes/kubernetes/kubernetes-standalone.md

@VidathVi

Copy link
Copy Markdown
Author

Hope these changes I suggested are useful. Let me know if something needs changing.

@VidathVi VidathVi changed the title Fixed four incorrect documentations related to terminal commands Fix incorrect terminal commands in API Platform Documentation Aug 4, 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