-
Notifications
You must be signed in to change notification settings - Fork 95
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
Add CLI procedure for syncing content view #3235
base: master
Are you sure you want to change the base?
Add CLI procedure for syncing content view #3235
Conversation
The PR preview for 4b4b514 is available at theforeman-foreman-documentation-preview-pr-3235.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.
hammer proxy content synchronize
is present on Foreman 3.11 ✔️
However, I think we should drop the output from "--help" and instead add a short description of what it does and which options are required.
I also have concerns about the title: It indicates that you can synchronize remote content to Foreman based on content views. However, the Hammer CLI command looks like it's about synchronizing CVs from Foreman Server to Smart Proxy Servers based on CVs. Please clarify or correct me.
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.
@bangelic Can you provide more details about why you are adding this? For example, if this is a new command, I would argue that you don't need a full section (just a release note could be enough). If there is a customer case that requests documenting the command, you could just mention it in another section (preferably in a procedure that customer was following when they hit the issue).
Without further clarification as to where the request to add the command comes from, I would not support adding a section like this. I find it hard to imagine a scenario where adding this section would do more than simply duplicate a --help
output.
@asteflova I think some documentation mentioning that this functionality is available past a release note would be helpful, it's a unique feature in that you can only do it via hammer. Users might not think to look in the hammer help text to discover that the feature is possible. |
Fair enough, thanks for the details.
That could definitely work. If we have a procedure during which users might need that new command, it would be good to mention it there. If we don't have an existing procedure like that, I think the new command should also appear in the Hammer CLI guide, right? So a release note could link to the appropriate section in the Hammer CLI guide. |
856b383
to
defd3c5
Compare
@maximiliankolb I think that @ianballou will be able to clarify but he will be on PTO until 9/13. Will check with him when he returns. |
I think this would be covered by the short discussion I had with @asteflova above. No need for the help text, but an addition to the smart proxy syncing guide that mentions hammer can be used to sync content views (and even repositories!) from Foreman to smart proxies via
I agree. This comment might have different context now based on what I mentioned above, but just make sure it's clear the syncing is from Foreman to smart proxies. |
defd3c5
to
37ed367
Compare
guides/common/modules/proc_synchronizing-a-content-view-to-a-smartproxy.adoc
Show resolved
Hide resolved
guides/common/modules/proc_synchronizing-a-content-view-to-a-smartproxy.adoc
Outdated
Show resolved
Hide resolved
guides/common/modules/proc_synchronizing-a-content-view-to-a-smartproxy.adoc
Outdated
Show resolved
Hide resolved
37ed367
to
4b4b514
Compare
A CLI procedure for synchronizing a content view has been added to the
Content Management Guide related to
https://issues.redhat.com/browse/SAT-13027.
Please cherry-pick my commits into: