Managing hosts adding network interfaces #3431
Open
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
apinnick
reviewed
Nov 6, 2024
guides/common/modules/proc_adding-a-bonded-interface-using-cli.adoc
Outdated
Show resolved
Hide resolved
guides/common/modules/proc_adding-a-bonded-interface-using-cli.adoc
Outdated
Show resolved
Hide resolved
apinnick
reviewed
Nov 6, 2024
| . Navigate to the *Add Interface* form: | ||
| + | ||
| -- | ||
| * Navigate to *Hosts* > *All Hosts*. |
There was a problem hiding this comment.
AFAIK, we use numbering, not bullets, for substeps.
There was a problem hiding this comment.
I'll default to complying with the rest of the docs for consistency, but I'll present my logic just in case:
- The usual option results into the
a. b. c.numbering, which is counterintuitive (looks like answer options in a test) - It's possible to do the better
i. ii. iii.numbering, but the markup is illogical (.for level one items,...for level two items) - I chose bullet points, because the markup is clean enough, and the result is clear. Plus, most of the grouped steps can be done in any order, it's a form in the UI.
I'll wait for a 👍 from another reviewer to change these to a. b. c..
There was a problem hiding this comment.
My point of view is based on "separating content from presentation": you want to add substeps, so let's use the markup for substeps. The way that markup is rendered is a separate issue.
rh-max
added
Needs tech review
rh-max
force-pushed
the
managing-hosts-adding-network-interfaces
branch
from
c151bac
to
95568b4
Compare
rh-max
force-pushed
the
managing-hosts-adding-network-interfaces
branch
from
987bae4
to
630b523
Compare
rh-max
force-pushed
the
managing-hosts-adding-network-interfaces
branch
from
630b523
to
8280430
Compare
Lennonka
requested changes
Nov 14, 2024
|
|
||
| include::modules/proc_adding-a-physical-interface.adoc[leveloffset=+1] | ||
| include::modules/con_network-interface-configuration-options.adoc[leveloffset=+1] |
There was a problem hiding this comment.
I'd see this as a reference file ref_ at the end of the assembly.
| When adding a network interface, you need to specify several configuration options. The following lists provide information on the relevant options for the different types of interfaces. | ||
|
|
||
| [id="Physical_interface_settings_{context}"] | ||
| == Physical interface settings |
There was a problem hiding this comment.
Suggested change
| == Physical interface settings | |
| .Physical interface settings |
I'd prefer informal headings to separate the options.
| [id="Virtual_interface_settings_{context}"] | ||
| == Virtual interface settings | ||
|
|
||
| * *Tag*. You can set a VLAN tag to trunk a network segment from the physical network through to the virtual interface. |
There was a problem hiding this comment.
Suggested change
| * *Tag*. You can set a VLAN tag to trunk a network segment from the physical network through to the virtual interface. | |
| *Tag*:: You can set a VLAN tag to trunk a network segment from the physical network through to the virtual interface. |
Is there a reason for a different markup than the options above?
| [id="Bonded_interface_settings_{context}"] | ||
| == Bonded interface settings | ||
|
|
||
| * *Mode*. The bonding mode defines a policy for fault tolerance and load balancing. |
There was a problem hiding this comment.
Suggested change
| * *Mode*. The bonding mode defines a policy for fault tolerance and load balancing. | |
| *Mode*:: The bonding mode defines a policy for fault tolerance and load balancing. |
Same here.
pr-processor
bot
added
the
Waiting on contributor
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.
What changes are you introducing?
Improvements to the "Adding network interfaces" section of the Managing hosts guide.
Why are you introducing these changes? (Explanation, links to references, issues, etc.)
https://issues.redhat.com/browse/SAT-26429
Anything else to add? (Considerations, potential downsides, alternative solutions you have explored, etc.)
Checklists
Please cherry-pick my commits into: