Netplan docs rework (Part 2) #337
Merged
Conversation
This file contains 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
Add manpages for the commands "info", "ip", "rebind" and "status".
The list of network keys are indexing their respective sections. Each section was expanded with a short description and explanation about the network type with a small example.
slyon
approved these changes
Apr 3, 2023
doc/cli.md
Outdated
Comment on lines
30
to
31
| | [info](/netplan-info) | Show available features | | ||
| | [ip](/netplan-ip) | Retrieve IP information from the system | |
There was a problem hiding this comment.
"ip" and "info" seem to be duplicated in the index. We should drop the two entries above.
doc/netplan-yaml.md
Outdated
|
|
||
| **Purpose**: Use the `ethernets` key to configure Ethernet interfaces. | ||
|
|
||
| **Structure**: The key consists of a mapping of interface names. Each `ethernet` has a number of configuration options. You don't need to define each interface by their names inside the `ethernets` mapping. You can use any name that describes the interface and match the actual network card using the `match` key. The general configuration structure for ethernets is shown below. |
There was a problem hiding this comment.
It's not necessarily interface names, but can be generic IDs (if combined with a match stanza)
maybe use "IDs" instead of "interface names"
doc/netplan-yaml.md
Outdated
|
|
||
| **Purpose**: Use the `modems` key to configure Modems. GSM/CDMA modem configuration is only supported for the `NetworkManager` backend. `systemd-networkd` does not support modems. | ||
|
|
||
| **Structure**: The key consists of a mapping of modem names. Each `modem` has a number of configuration options. The general configuration structure for modems is shown below. |
There was a problem hiding this comment.
maybe replace "modem names" by "modem IDs"
doc/netplan-yaml.md
Outdated
|
|
||
| **Purpose**: Use the `tunnels` key to create different virtual tunnel interfaces. | ||
|
|
||
| **Structure**: The key consists of a mapping of tunnel names. Each `tunnel` requires the identification of the tunnel mode (see the section `mode` below for the list of supported modes). The general configuration structure for bridges is shown below. |
There was a problem hiding this comment.
"tunnel names" -> "tunnel interfaces"
"for bridges" -> "for tunnels"
doc/netplan-yaml.md
Outdated
|
|
||
| **Purpose**: Use the `vlans` key to create VLAN interfaces. | ||
|
|
||
| **Structure**: The key consists of a mapping of VLAN names. The interface used in the `link` option (`enp5s0` in the example below) must also be defined in the Netplan configuration. The general configuration structure for bridges is shown below. |
There was a problem hiding this comment.
"VLAN names" -> "VLAN interfaces"
"for bridges" -> "for vlans"
doc/netplan-yaml.md
Outdated
| The `nm-devices` device type is for internal use only and should not be used in | ||
| **Status**: Optional. Its use is not recommended. | ||
|
|
||
| **Purpose**: Use the `nm-devices` key to configure device types that are not supported by Netplan. This is Network Manager (NM) specific configuration. |
There was a problem hiding this comment.
"Network Manager (NM)" -> "NetworkManager"
doc/netplan-ip.md
Outdated
|
|
||
| ## NAME | ||
|
|
||
| netplan-ip - retrieve IP information from the system |
There was a problem hiding this comment.
Suggested change
| netplan-ip - retrieve IP information from the system | |
| netplan-ip - retrieve IP information (like DHCP leases) from the system |
Also below.
doc/netplan-ip.md
Outdated
|
|
||
| ## DHCP COMMANDS | ||
|
|
||
| **leases** `INTERFACE`: Displays IP leases |
There was a problem hiding this comment.
Suggested change
| **leases** `INTERFACE`: Displays IP leases | |
| **leases** `INTERFACE`: Displays DHCP IP leases |
doc/netplan-rebind.md
Outdated
|
|
||
| ## DESCRIPTION | ||
|
|
||
| **netplan rebind [netdevs]** rebinds SR-IOV virtual functions of given physical functions to their driver. |
There was a problem hiding this comment.
Suggested change
| **netplan rebind [netdevs]** rebinds SR-IOV virtual functions of given physical functions to their driver. | |
| **netplan rebind [interfaces]** rebinds SR-IOV virtual functions of given physical functions to their driver. |
Also below & above.
daniloegea
added a commit
that referenced
this pull request
May 17, 2023
Adding man pages for all the commands. Improving the network types descriptions a little. Follow-up for #333 COMMITS: * docs: add missing manpages Add manpages for the commands "info", "ip", "rebind" and "status". * docs: improve the Netplan reference The list of network keys are indexing their respective sections. Each section was expanded with a short description and explanation about the network type with a small example. * doc: refine wording & formatting
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.
Description
Adding man pages for all the commands.
Improving the network types descriptions a little.
Follow-up for #333
Checklist
make checksuccessfully.make check-coverage).