-
Notifications
You must be signed in to change notification settings - Fork 105
Refer to foremanctl as 'deployment tool' rather than 'installer' #4436
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Refer to foremanctl as 'deployment tool' rather than 'installer' #4436
Conversation
348673a to
ddb4f08
Compare
|
The PR preview for 4450d9e is available at theforeman-foreman-documentation-preview-pr-4436.surge.sh The following output files are affected by this PR: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for picking up on this.
guides/common/modules/proc_running-project-deployment-utility.adoc
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
guides/doc-Quickstart/master.adoc
Outdated
| The full installation guide is currently provided only for the Puppet-based installation. | ||
|
|
||
| :FeatureName: The `foremanctl` installer | ||
| :FeatureName: The `foremanctl` deployment tool |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In the other file you call it "utility", not "tool", while both refer to the same thing, I guess it's easier if the same word is used?
ACK either way.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should add a description in the About section of https://github.com/theforeman/foremanctl that we can reuse here. For now it can only deploy, but we've also been talking about merging foreman-maintain functionality into it so we may need to revisit this if/when we do.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I took a look at the About section but I don't think I can help with that because I don't have permissions in that repo. So for now, I'm going to go ahead with merging this PR and if the description there turns out to be significantly different from what we have in the Quickstart guide, we can sync them later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please, can we pick one of those words (tool/utility) and use it consistently?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you!
(cherry picked from commit da5bb6f)
What changes are you introducing?
Changing references to
foremanctlfrom "installer" to "deployment tool/utility".Why are you introducing these changes? (Explanation, links to references, issues, etc.)
In
foremanctl, the existingforeman-installerandforeman-maintaintools will merge into one "deployment tool". Changing the wording we use to refer to the tool seems appropriate.Anything else to add? (Considerations, potential downsides, alternative solutions you have explored, etc.)
N/A
Contributor checklists
Please cherry-pick my commits into: