Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: improve explanation of networking approach #633

Merged
merged 4 commits into from
Feb 18, 2025

Conversation

minaelee
Copy link
Contributor

This PR adds an explanation/networking page to explain MicroCloud's networking approach, including its use of OVN and a comparison to VPCs (Virtual Private Clouds).

This reduces the need for a Networking section in the About MicroCloud page. A separate commit removes most of that section, and also re-allocates most of the remaining information to a more suitable location: the Reference page on networking requirements. It also updates relevant links.

@github-actions github-actions bot added the Documentation Documentation needs updating label Feb 13, 2025
@minaelee minaelee force-pushed the explain-networking-approach branch from e8ec1fc to 057ddca Compare February 13, 2025 03:03
Copy link
Member

@tomponline tomponline left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall great thanks, ive left a few suggestions though.

@minaelee minaelee force-pushed the explain-networking-approach branch from 057ddca to 52141e8 Compare February 13, 2025 17:46
@minaelee
Copy link
Contributor Author

Overall great thanks, ive left a few suggestions though.

Thank you! Should all be addressed.

@minaelee minaelee requested a review from tomponline February 18, 2025 15:05
tomponline
tomponline previously approved these changes Feb 18, 2025
mionaalex
mionaalex previously approved these changes Feb 18, 2025
Copy link

@mionaalex mionaalex left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only now got a chance to thoroughly review. Approved from my side when it comes to structure, readability and context. I think it provides a good overview and clarity. For technical correctness I'll rely on the engineers to double-check.

Copy link
Contributor

@roosterfish roosterfish left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, just two small comments.

doc/how-to/ovn_underlay.md Outdated Show resolved Hide resolved
doc/reference/index.md Outdated Show resolved Hide resolved
@minaelee minaelee dismissed stale reviews from mionaalex and tomponline via c7a3e9f February 18, 2025 17:20
@minaelee minaelee force-pushed the explain-networking-approach branch from 52141e8 to c7a3e9f Compare February 18, 2025 17:20
@minaelee minaelee force-pushed the explain-networking-approach branch from c7a3e9f to bac4fa9 Compare February 18, 2025 17:22
@minaelee
Copy link
Contributor Author

Looks good, just two small comments.

Addressed, thanks!

@minaelee minaelee requested a review from roosterfish February 18, 2025 17:27
@roosterfish roosterfish merged commit d86a47e into canonical:main Feb 18, 2025
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Documentation needs updating
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants