Bug 2270126

Document URL: https://access.redhat.com/documentation/en-us/red_hat_satellite/6.14/html/managing_content/managing_application_lifecycles_content-management#Creating_a_Lifecycle_Environment_Path_content-management

Section Number and Name: 7.3. Creating a Lifecycle Environment Path


Describe the issue: "CLI Procedure" seems to be using effectively the exact same command  to do two different things. It says

To create an environment path, enter the hammer lifecycle-environment create command and specify the Library environment with the --prior option:

# hammer lifecycle-environment create \
--name "Environment Path Name" \
--description "Environment Path Description" \
--prior "Library" \
--organization "My_Organization"
Optional: To add an environment to the environment path, enter the hammer lifecycle-environment create command and specify the parent environment with the --prior option:

# hammer lifecycle-environment create \
--name "Environment Name" \
--description "Environment Description" \
--prior "Prior Environment Name" \
--organization "My_Organization"

Note: Essentially Applies for all satellite version documentation.

Suggestions for improvement: 

1] In the first case which creates a new Environment Path, it should not be necessary to include ' --prior "Library" '. The command knows that it has to create a new Environment Path simply from the fact that the one referred to does not exist, so this option seems to be redundant.

2]  In second command, Since Lifecycle is already created and we want to add another Lifecycle environment path to it, then we can mention new Lifecycle environment in  "--name "Environment Path Name"  and prior to "--prior "Previously created LCE" '

So for the first use case, where we say "--name" we mean the Lifecycle Path name itself, in the second apparently we mean the name of the new lifecycle environment we are adding to the Path. Document should not have Two identical commands where the same option refers to two different things depending on context.

3] The command is specifying , if you do not have any prior environments then use Library and if you have any 'prior' environment and want to specify it then you can specify.


Additional information: