Improve usage doc, fix typos and follow style guide #89
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
size/L
bug
opensovereigncloud-user
force-pushed
the
osc/enh/improve-docs
branch
from
ad2051f to
48b052e
Compare
afritzler
requested changes
Jul 15, 2025
docs/iaas/usage-guides/networking.md
Outdated
| @@ -1,5 +1,7 @@ | |||
| # Networking Resources | |||
|
|
|||
| This guide describes the core networking resources in IronCore, such as `Networks`, `NetworkInterfaces`, `VirtualIPs`, `NAT gateways`, `LoadBalancers`, and `NetworkPolicies`. It explains how to define, configure, and manage these resources for the infrastructure. | |||
There was a problem hiding this comment.
Suggested change
| This guide describes the core networking resources in IronCore, such as `Networks`, `NetworkInterfaces`, `VirtualIPs`, `NAT gateways`, `LoadBalancers`, and `NetworkPolicies`. It explains how to define, configure, and manage these resources for the infrastructure. | |
| This guide describes the core networking resources in IronCore, such as `Networks`, `NetworkInterfaces`, `VirtualIPs`, `NAT gateways`, `LoadBalancers`, and `NetworkPolicies`. |
docs/iaas/usage-guides/networking.md
Outdated
|
|
||
| ### Reconciliation Process: | ||
| - `peerings` (`list`): Are the list of network peerings with this `Network` (optional). | ||
|
|
docs/iaas/usage-guides/networking.md
Outdated
| Once created and with an allocated ID, the IronCore `Network` will be patched with the corresponding provider ID of the apinet Network and set to state: `Available`. | ||
| Once the `Network` resource is in an available state. The format of a network provider ID is as follows: | ||
| `ironcore-net://<namespace>/<name>/<id>/<uid>` | ||
| - **Network creation**: [ironcore-net](https://github.com/ironcore-dev/ironcore-net) is the network plugin for IronCore that realizes the `Network` resource, When an IronCore `Network` is created, a corresponding `core.apinet.ironcore.dev/Network` is created in the ironcore-net(apinet) cluster. |
There was a problem hiding this comment.
Suggested change
| - **Network creation**: [ironcore-net](https://github.com/ironcore-dev/ironcore-net) is the network plugin for IronCore that realizes the `Network` resource, When an IronCore `Network` is created, a corresponding `core.apinet.ironcore.dev/Network` is created in the ironcore-net(apinet) cluster. | |
| - **Network creation**: [ironcore-net](https://github.com/ironcore-dev/ironcore-net) is the network plugin for IronCore that realizes the `Network` resource. When an IronCore `Network` is created, a corresponding `core.apinet.ironcore.dev/Network` is created in the ironcore-net(apinet) cluster. |
docs/iaas/usage-guides/networking.md
Outdated
| - name: peering1 | ||
| state: Ready | ||
| state: Available | ||
|
|
opensovereigncloud-user
force-pushed
the
osc/enh/improve-docs
branch
from
6d2dcaf to
cae317f
Compare
opensovereigncloud-user
force-pushed
the
osc/enh/improve-docs
branch
from
cae317f to
e95812d
Compare
opensovereigncloud-user
force-pushed
the
osc/enh/improve-docs
branch
from
e95812d to
c891dd2
Compare
afritzler
approved these changes
Jul 23, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed Changes