Doc Feedback: Port descriptions are not clear
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 99
- Forks
- 708
- Avg merge
- 1d 7h
- Merged PRs (30d)
- 22
Description
Location : https://apim.docs.wso2.com/en/latest/install-and-setup/setup/reference/default-product-ports/
From the documentation I cannot answer the following questions regarding port numbers:
Micro Integrator Ports
- What is the port number of the Micro Integrator Dashboard?
- What is the port number for the Micro Integrator? What does "The port of the HTTPS Passthrough transport." mean? Is this the port number I need to expose on the load balancer to access the Micro Integrator?
API-M ports
- Which port is responsible for handling the incoming API requests?
- Which ports belong to the control plane, traffic manager and gateway if I run them separately?
- Is the management console, publisher and developer portal exposed on the same port - 9443?
Traffic Manager
... No ports documented (or, mentioned clearly) ...
Control Plane
... No ports documented (or, mentioned clearly) ...
What will be helpful is a diagram showing which port numbers are used to connect the various components internally (used for internal communication between all components) and which ports expose functionality externally - meaning those ports that I should open on the load balancer to handle incoming traffic.
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 at the default product ports documentation page linked in the issue and review the Micro Integrator, API-M, Traffic Manager, and Control Plane sections. Document which ports serve internal communication versus externally exposed functionality, answer the listed component questions, and add a diagram covering those connections.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100