oakestra / oakestra/documentation
Document changes in oak issue #524
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 0
- Forks
- 3
- Avg merge
- 2h 4m
- Merged PRs (30d)
- 2
Description
Add documentation for https://github.com/oakestra/oakestra/issues/524
Make sure it is clear that the IP assignment in NodeEngine is not the same as a custom IP assignment in NetManager.
NetManager IPs -> used for overlay network
NodeEngine IP -> Shows in the dashbaord when a service is deployed showing the user what IP to use to reach the app (if the app exposes public ports)
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 by reading oak issue #524 and the existing documentation for NodeEngine and NetManager. No documentation file or test is named in the issue, so first locate where IP assignment is currently explained. Done means clearly distinguishing NetManager IPs for the overlay network from the NodeEngine IP shown in the dashboard for reaching exposed applications.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100