[Improvement]: Payloads and commands in the Setup Guide needs to be Updated to match with the latest Implementation
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 2
- Forks
- 64
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 34
Description
Current Limitation
Currently, in certain docs(Ex: K8s Deployment Guide for AI-Gateway) the setup guidelines and commands still refers to old versions of the services
curl -X POST http://localhost:9090/api/management/v0.9/rest-apis \
-u "$ADMIN_USERNAME:$ADMIN_PASSWORD" \
-H "Content-Type: application/yaml" \
--data-binary @- <<'EOF'
apiVersion: gateway.api-platform.wso2.com/v1alpha1
kind: RestApi
...
And in certain cases, the examples doesn't match with their relevant gateway type(Ex: In the AI-Gateway deployment, we should include payloads for deploying LLMProvider, MCP, etc. Not of REST APIs)
Suggested Improvement
Update the documentation to match with latest implementation
Version
No response
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the K8s Deployment Guide for AI-Gateway linked in the issue and review its setup commands and example payloads against the latest implementation. Update outdated service versions and use gateway-appropriate examples such as LLMProvider and MCP payloads, then verify that the revised documentation is consistent and usable.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- kubernetes
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100