-
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
Change command for Lifecycle and Environment Path #3533
base: master
Are you sure you want to change the base?
Conversation
@sjha4 Can you take a look at the changes I made here and let me know if this is accurate to what was discussed with Jeremy? Thanks! |
The PR preview for 8546a15 is available at theforeman-foreman-documentation-preview-pr-3533.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.
I made a suggestion based on https://docs.theforeman.org/nightly/Managing_Content/index-katello.html#Creating_a_Lifecycle_Environment_Path_content-management
It's longer but hopefully helpful to readers.
guides/common/modules/proc_creating-a-lifecycle-environment-path.adoc
Outdated
Show resolved
Hide resolved
guides/common/modules/proc_creating-a-lifecycle-environment-path.adoc
Outdated
Show resolved
Hide resolved
963a27a
to
cea9cc2
Compare
guides/common/modules/proc_creating-a-lifecycle-environment-path.adoc
Outdated
Show resolved
Hide resolved
guides/common/modules/proc_creating-a-lifecycle-environment-path.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.
Please, @bangelic, always add a link to the Jira issue in the PR description for better context of your changes.
https://issues.redhat.com/browse/SAT-24004
I think you're missing the point of the reported bug. The reporter wants to make the two commands more differentiated because it's not clear how and why they are different. Therefore, using the same --name
example for both does not help.
We're creating an LC environment with each command, not the whole path. The LC env. path is a result of the chain of environments. Let's not use "path" in the --name
.
Also, we don't have to use underscores in the example text when it's a name. Only labels use underscores. Let's not put them here.
guides/common/modules/proc_creating-a-lifecycle-environment-path.adoc
Outdated
Show resolved
Hide resolved
Please, also fix the following in the last step. I cannot comment on it directly. |
For specifying path to add the environment after library, we exposed the Might be helpful to document this as well: |
cea9cc2
to
fbf1045
Compare
@sjha4 @bangelic The parameter should be documented in Hammer help. I don't think it's particularly helpful glueing this example command to this procedure. We do not document every Hammer parameter in product documentation as users can look it up in Hammer reference help. That's my two cents. It's also out of the scope of this PR. We're fixing a bug here. :)) |
fbf1045
to
8546a15
Compare
What changes are you introducing?
Updating command language.
Why are you introducing these changes? (Explanation, links to references, issues, etc.)
The language in two different commands appears redundant.
Anything else to add? (Considerations, potential downsides, alternative solutions you have explored, etc.)
Checklists
Please cherry-pick my commits into: