Skip to content

Commit c891dd2

Browse files
committed
address review comments
1 parent e9799d3 commit c891dd2

File tree

3 files changed

+18
-23
lines changed

3 files changed

+18
-23
lines changed

docs/contribute/contributing.md

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -64,32 +64,32 @@ process. We use [the standard DCO text of the Linux Foundation](https://develope
6464

6565
* Fork and clone the repository to your local machine.
6666

67-
```shell
68-
git clone [email protected]:ironcore-dev/ironcore-dev.github.io.git
69-
cd docs
70-
```
67+
```shell
68+
git clone [email protected]:ironcore-dev/ironcore-dev.github.io.git
69+
cd docs
70+
```
7171

7272
* Create a branch from the `main` using 'git checkout' command.
7373
!!! note
7474
If needed, rebase to the current `main` branch before submitting your pull request. If it doesn't merge properly
7575
with `main` you may be asked to rebase your changes.
7676

77-
```shell
78-
git checkout -b my_feature
79-
# rebase if necessary
80-
git fetch upstream main
81-
git rebase upstream/main
82-
```
77+
```shell
78+
git checkout -b my_feature
79+
# rebase if necessary
80+
git fetch upstream main
81+
git rebase upstream/main
82+
```
8383

8484
* Commits should be as small as possible, while ensuring that each commit is correct independently
8585

8686
* Commit your changes to your feature branch and push it to your fork.
8787

88-
```shell
89-
git add .
90-
git commit -m "Something meaningful"
91-
git push origin my_feature
92-
```
88+
```shell
89+
git add .
90+
git commit -m "Something meaningful"
91+
git push origin my_feature
92+
```
9393

9494
!!! note
9595
Alternatively you can amend your commit before pushing if you forgot something by using `git commit --amend`
@@ -111,5 +111,4 @@ for a review in the pull request or a comment.
111111
We use GitHub issues to track bugs and enhancement requests. Please provide as much context as possible when you open an issue. The information you provide must be comprehensive enough to understand, reproduce the behavior and find related reports of that issue for the assignee.
112112
Therefore, contributors may use but aren't restricted to the issue template provided by the IronCore maintainers.
113113

114-
115114
Thank you for helping improve our documentation!

docs/iaas/usage-guides/ipam.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# IPAM Resources
2+
23
This guide explains how to use IronCore's integrated IP address management (IPAM) resources to define and manage IP prefixes and allocations.
34

45
## Prefix

docs/iaas/usage-guides/networking.md

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Networking Resources
22

3-
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.
3+
This guide describes the core networking resources in IronCore, such as `Networks`, `NetworkInterfaces`, `VirtualIPs`, `NAT gateways`, `LoadBalancers`, and `NetworkPolicies`.
44

55
## Network
66

@@ -26,11 +26,9 @@ spec:
2626
### Key Fields:
2727
2828
- `peerings` (`list`): Are the list of network peerings with this `Network` (optional).
29-
30-
3129
### More about IronCore Network:
3230

33-
- **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.
31+
- **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.
3432
Once created and with an allocated ID, the IronCore `Network` will be patched with the corresponding providerID of the apinet Network and set to state: `Available`.
3533
The format of a network providerID is as follows:
3634
`ironcore-net://<namespace>/<name>/<id>/<uid>`
@@ -61,7 +59,6 @@ status:
6159
- name: peering1
6260
state: Ready
6361
state: Available
64-
6562
```
6663

6764
For detailed e2e example on network peering
@@ -73,7 +70,6 @@ A `NetworkInterface` resource in IronCore represents a connection point between
7370
network. It encapsulates the configuration and life cycle management of the virtual network interface, ensuring
7471
seamless connectivity for `Machines`.
7572

76-
7773
### Example NetworkInterface Resource
7874

7975
An example of how to define a `NetworkInterface` resource in IronCore:
@@ -179,7 +175,6 @@ spec:
179175
- `portsPerNetworkInterface` (`int32`): This Specifies the number of ports allocated per network interface and controls how many simultaneous connections can be handled per interface. If empty, 2048 (DefaultPortsPerNetworkInterface) is the default.
180176
- `networkRef` (`string`): It represents which network this `NATGateway` serves.
181177

182-
183178
After reconciling all `NATGateways`, the status gets updated with the corresponding values for `ips` as shown below.
184179

185180
```yaml

0 commit comments

Comments
 (0)