WFCORE-5841 [primary/secondary] Review the documentation of affected CLI management operations #5098
Conversation
github-actions
bot
added
the
deps-ok
| @@ -46,8 +46,8 @@ ARGUMENTS | |||
| when it restarts. An ADMIN_ONLY controller will start any | |||
| configured management interfaces and accept management | |||
| requests, but will not start servers or, if this host | |||
| controller is the master for the domain, accept incoming | |||
| connections from slave host controllers. For embedded host | |||
| controller is the primary for the domain, accept incoming | |||
There was a problem hiding this comment.
Our analysis doc states the following:
"Where ‘master’ was used as a shorthand for ‘master Host Controller’ replace with either ‘Domain Controller’ or ‘primary Host Controller’."
So I think we should use ‘primary Host Controller’ here. @bstansberry Would you mind confirming? honestly, I always have difficulties with these kinds of subtlety.
There was a problem hiding this comment.
Same here, waiting for @bstansberry to confirm.
There was a problem hiding this comment.
@moulalis @yersan +1 for "primary Host Controller"
The way it is in the PR now is fine in terms of being correct English and being clear to the reader. But I think it will be easier for future maintainers whose 'primary' ;-) skill is writing code and not writing English if we follow the KISS principle and avoid shorthand.
There was a problem hiding this comment.
@moulalis Could you please update the PR accordingly? thanks!
There was a problem hiding this comment.
PR updated. Thanks.
…d CLI management operations
yersan
added
the
ready-for-merge
Issue: https://issues.redhat.com/browse/WFCORE-5841