Add link to Provisioning guide in the "Creating a host" procedure #3443
Conversation
|
The PR preview for a012983 is available at theforeman-foreman-documentation-preview-pr-3443.surge.sh The following output files are affected by this PR: |
rh-max
added
the
Needs style review
| @@ -4,6 +4,9 @@ | |||
| Use this procedure to create a host in {ProjectName}. | |||
| To use the CLI instead of the {ProjectWebUI}, see the xref:cli-creating-a-host_{context}[]. | |||
|
|
|||
| .Prerequisites | |||
| * Review the provider-specific procedures for creating a host in the {ProvisioningDocURL}[Provisioning guide]. | |||
There was a problem hiding this comment.
We have attributes for titles: You can always substitute "URL" for "Title": https://github.com/theforeman/foreman-documentation/blob/master/guides/common/attributes-titles.adoc#L26
| @@ -4,6 +4,9 @@ | |||
| Use this procedure to create a host in {ProjectName}. | |||
| To use the CLI instead of the {ProjectWebUI}, see the xref:cli-creating-a-host_{context}[]. | |||
|
|
|||
| .Prerequisites | |||
| * Review the provider-specific procedures for creating a host in the {ProvisioningDocURL}[Provisioning guide]. | |||
There was a problem hiding this comment.
This is not a prerequisite. If the provider-specific procedure exists in the Provisioning guide, the user does not need to follow this generic procedure.
There was a problem hiding this comment.
I agree with Avital. I'd suggest removing most of this procedure anyway because there are many requirements to be met before user can start creating hosts in order to provision them. Therefore, a generic procedure is not helpful. I would only keep the link and delete the procedure steps personally.
What changes are you introducing?
Adding a link to Provisioning guide in the "Creating a host" procedure -- the general procedure is helpful but insufficient.
Why are you introducing these changes? (Explanation, links to references, issues, etc.)
https://issues.redhat.com/browse/SAT-28626
Anything else to add? (Considerations, potential downsides, alternative solutions you have explored, etc.)
Checklists
Please cherry-pick my commits into: