Restore info on relevant optional fields in Register Host interface #3508
Conversation
|
The PR preview for 6672932 is available at theforeman-foreman-documentation-preview-pr-3508.surge.sh The following output files are affected by this PR: |
|
@asteflova Could you PTAL? I've tried to, on one hand, to not add redundant information, and on the other, to list the most important info on optional fields and retain relevant info about their workings. Thank you. |
rh-max
added
the
Needs style review
| endif::[] | ||
| and *Lifecycle environment* fields inherit their values from the host group. | ||
| ifdef::katello,satellite,orcharhino[] | ||
| * A Capsule behind a load balancer takes precedence over the Capsule selected in this UI as the host’s content source. |
There was a problem hiding this comment.
branding! "Capsule" -> "{SmartProxy}"
| ifdef::katello,satellite,orcharhino[] | ||
| , *Activation Keys* | ||
| endif::[] | ||
| and *Lifecycle environment* fields inherit their values from the host group. |
There was a problem hiding this comment.
The fields are inherited from the host group but not preselected. Is that intentional? On Foreman 3.13:
| @@ -48,8 +48,14 @@ endif::[] | |||
|
|
|||
| .Procedure | |||
| . In the {ProjectWebUI}, navigate to *Hosts* > *Register Host*. | |||
| . Enter the details for how you want the registered host to be configured. | |||
| . Enter the details for how you want the registered host to be configured. Note: | |||
There was a problem hiding this comment.
I'd drop "Note:". alternative:
| . Enter the details for how you want the registered host to be configured. Note: | |
| . Enter the details for how you want the registered host to be configured. | |
| + | |
| [NOTE] | |
| ==== | |
| ... | |
| ==== |
There was a problem hiding this comment.
| . Enter the details for how you want the registered host to be configured. Note: | |
| . Enter the details for how you want the registered host to be configured. |
An alternative. I think the bulleted list is "noteable" enough.
pr-processor
bot
added
Waiting on contributor
There was a problem hiding this comment.
I think this works nicely: you're adding a few more details as requested in the report but manage to avoid too much duplication between the web UI and the docs. Thanks for picking this up!
Note especially the suggestions to use attributes, that's the 'blocking' part of the feedback.
| @@ -48,8 +48,14 @@ endif::[] | |||
|
|
|||
| .Procedure | |||
| . In the {ProjectWebUI}, navigate to *Hosts* > *Register Host*. | |||
| . Enter the details for how you want the registered host to be configured. | |||
| . Enter the details for how you want the registered host to be configured. Note: | |||
There was a problem hiding this comment.
| . Enter the details for how you want the registered host to be configured. Note: | |
| . Enter the details for how you want the registered host to be configured. |
An alternative. I think the bulleted list is "noteable" enough.
| endif::[] | ||
| and *Lifecycle environment* fields inherit their values from the host group. | ||
| ifdef::katello,satellite,orcharhino[] | ||
| * A Capsule behind a load balancer takes precedence over the Capsule selected in this UI as the host’s content source. |
There was a problem hiding this comment.
| * A Capsule behind a load balancer takes precedence over the Capsule selected in this UI as the host’s content source. | |
| * A {SmartProxy} behind a load balancer takes precedence over the {SmartProxy} selected in the {ProjectWebUI} as the content source of the host." |
Attributes to avoid branding issues and minor rewording to avoid possessive apostrophe.
What changes are you introducing?
Returning selected info about optional fields in the Register Host interface of the Satellite UI.
Why are you introducing these changes? (Explanation, links to references, issues, etc.)
https://issues.redhat.com/browse/SAT-28703
Anything else to add? (Considerations, potential downsides, alternative solutions you have explored, etc.)
Checklists
Please cherry-pick my commits into: