Make multiple CV environments fit for all builds (theforeman#3806)

* Fix broken links
* Make example activation key italic
* Use ProjectWebUI attribute
* Use attributes for example content
* Use foreman-example-com macro in favor of hardcoded FQDN
* Use sentence-case capitalization
* Write Hammer CLI in favor of Hammer

Refs PR 3609 on GitHub

Author: maximiliankolb

guides/common/assembly_managing-content-view-environments.adoc

@@ -4,7 +4,20 @@ include::modules/con_content-view-environments-overview.adoc[leveloffset=+1]
 
 include::modules/con_content-view-environment-categories.adoc[leveloffset=+1]
 
+ifdef::satellite[]
+:example-repo-id: satellite-client-6-for-rhel-9-x86_64-rpms
+:example-repo-name: Red Hat Satellite Client 6 for RHEL 9 x86_64 (RPMs)
+:example-repo-url: https://{foreman-example-com}/pulp/content/_My_Organization_/Library/cv1/content/dist/layered/rhel9/x86_64/_My_Product_/_My_Repository_ID_/os
+endif::[]
+ifndef::satellite[]
+:example-repo-id: {project-context}-client
+:example-repo-name: {Project} Client
+:example-repo-url: https://{foreman-example-com}/pulp/content/_My_Organization_/Library/cv1/content/dist/layered/{project-context}-client/x86_64/_My_Product_/_My_Repository_ID_/os
+endif::[]
 include::modules/con_content-view-environment-ordering-and-priority.adoc[leveloffset=+1]
+:!example-repo-id:
+:!example-repo-name:
+:!example-repo-url:
 
 include::modules/proc_assigning-content-view-environments-to-hosts.adoc[leveloffset=+1]
 

guides/common/modules/con_comparison-of-content-view-environments-and-composite-content-views.adoc

@@ -5,17 +5,17 @@ Composite content views provide an alternative method for granting hosts access
 You can use composite content views, multiple content view environments, or a combination of both.
 The key differences between these methods include the following:
 
-Access Timing::
+Access timing::
 Hosts assigned to composite content views gain access to the combined content only after you publish the composite content view.
 Hosts assigned to multiple content view environments immediately access the combined content from all assigned environments.
 
-Conflict Resolution::
+Conflict resolution::
 Composite content views resolve conflicts at the time of publishing by merging duplicate repositories.
 For hosts assigned to multiple content view environments, repository conflicts are resolved based on the order of content view environments.
 For more information about content view environment ordering and priority, see xref:content-view-environment-ordering-and-priority[].
 
-Version Selection::
+Version selection::
 Composite content views allow you to select specific versions of a content view, including older versions.
 With multiple content view environments, the host always receives the latest version of the content view with no option to select a different version.
 
-Choose the approach that best suits your requirements based on these differences.
+Choose the approach that best suits your requirements based on these differences.

guides/common/modules/con_content-view-environment-ordering-and-priority.adoc

@@ -20,7 +20,7 @@ $ hammer host update \
 --name "{server-example-com}" \
 --organization-id _My_Organization_ID_
 ----
-Both content view environments include the `satellite-client-6-for-rhel-9-x86_64-rpms` repository.
+Both content view environments include the `{example-repo-id}` repository.
 Log in as a `root` user, then run `subscription-manager repos` to inspect the available repositories on the host. 
 The output reflects the `Library/cv1` content view environment:
 [options="nowrap" subs="+quotes"]
@@ -34,9 +34,9 @@ This results in the following output:
 +----------------------------------------------------------+
     Available Repositories in /etc/yum.repos.d/redhat.repo
 +----------------------------------------------------------+
-Repo ID:   satellite-client-6-for-rhel-9-x86_64-rpms
-Repo Name: Red Hat Satellite Client 6 for RHEL 9 x86_64 (RPMs)
-Repo URL:  https://centos9-katello-devel-stable.example.com/pulp/content/Default_Organization/Library/cv1/content/dist/layered/rhel9/x86_64/sat-client/6/os
+Repo ID:   {example-repo-id}
+Repo Name: {example-repo-name}
+Repo URL:  {example-repo-url}
 Enabled:   0
 ----
 [NOTE]
@@ -66,9 +66,9 @@ This results in the following output:
 +----------------------------------------------------------+
     Available Repositories in /etc/yum.repos.d/redhat.repo
 +----------------------------------------------------------+
-Repo ID:   satellite-client-6-for-rhel-9-x86_64-rpms
-Repo Name: Red Hat Satellite Client 6 for RHEL 9 x86_64 (RPMs)
-Repo URL:  https://centos9-katello-devel-stable.example.com/pulp/content/Default_Organization/dev/cv1/content/dist/layered/rhel9/x86_64/sat-client/6/os
+Repo ID:   {example-repo-id}
+Repo Name: {example-repo-name}
+Repo URL:  {example-repo-url}
 Enabled:   0
 ----
-The `Repo URL` now reflects the `dev/cv1` content view environment, meaning the system uses content from `dev/cv1` and ignores `Library/cv1`.
+The `Repo URL` now reflects the `dev/cv1` content view environment, meaning the system uses content from `dev/cv1` and ignores `Library/cv1`.

guides/common/modules/con_content-view-environments-overview.adoc

@@ -4,17 +4,17 @@
 The *Allow multiple content views* setting controls whether hosts and activation keys can be assigned to multiple content view environments.
 By default, this feature is disabled, limiting assignments to a single content view environment.
 Enable this setting to assign multiple content view environments to hosts and activation keys.
-For more information on content settings, see {AdministeringDocURL}content_settings_{context}[Content settings] in _{AdministeringDocTitle}_.
+For more information on content settings, see {AdministeringDocURL}content_settings_admin[Content settings] in _{AdministeringDocTitle}_.
 
 Hosts registered with multiple activation keys handle content view environment assignments based on the key order and settings configuration.
 For more information about content view environment ordering and priority, see xref:content-view-environment-ordering-and-priority[].
 
 When you disable *Allow multiple content views*, multi-environment hosts remain assigned to multiple content view environments and retain access to all their content.
-Existing multi-environment activation keys remain associated with multiple content view environments, and both multi-environment hosts and activation keys remain visible in the web UI and accessible through the Hammer CLI.
+Existing multi-environment activation keys remain associated with multiple content view environments, and both multi-environment hosts and activation keys remain visible in the {ProjectWebUI} and accessible through the Hammer CLI.
 However, registration fails if you attempt to assign a host to multiple content view environments or use a multi-environment activation key during host registration.
 Assigning multiple content view environments to a host or activation key results in an error.
 
 When you disable *Allow multiple content views*, you can still reassign a multi-environment host to a single content view environment.
 You can also reassign a multi-environment activation key to a single content view environment or remove all content view environments from the key.
 
-This setting provides flexibility in managing how content view environments are applied to hosts and activation keys while ensuring consistent behavior when disabled.
+This setting provides flexibility in managing how content view environments are applied to hosts and activation keys while ensuring consistent behavior when disabled.

guides/common/modules/proc_assigning-content-view-environments-to-activation-keys.adoc

@@ -8,12 +8,12 @@ For more information, see xref:content-view-environment-ordering-and-priority[].
 [NOTE]
 ====
 You cannot reassign a multi-environment activation key's content view environments using the {ProjectWebUI}.
-To change content view environments, update the activation key with Hammer.
+To change content view environments, update the activation key with Hammer CLI.
 ====
 
 .Prerequisites
 * The *Allow multiple content views* setting must be enabled.
-For more information on content settings, see {AdministeringDocURL}content_settings_{context}[Content settings] in _{AdministeringDocTitle}_.
+For more information on content settings, see {AdministeringDocURL}content_settings_admin[Content settings] in _{AdministeringDocTitle}_.
 
 .CLI procedure
 . Display the available content view environments to obtain their labels or IDs:
@@ -22,7 +22,6 @@ For more information on content settings, see {AdministeringDocURL}content_setti
 ----
 $ hammer content-view-environment list
 ----
-+
 . Assign content view environments to an activation key:
 * By using their labels:
 +
@@ -41,4 +40,4 @@ $ hammer activation-key update \
 --id _My_Activation_Key_ID_ \
 --organization-id _My_Organization_ID_ \
 --content-view-environment-ids [_My_content_view_env_ID_1_, _My_content_view_env_ID_2_] 
-----
+----

guides/common/modules/proc_removing-all-content-view-environments-from-an-activation-key.adoc

@@ -19,6 +19,6 @@ $ hammer activation-key update \
 ----
 $ hammer activation-key update \
 --content-view-environments "" \
---name My_Activation_Key \
+--name _My_Activation_Key_ \
 --organization-id _My_Organization_ID_
 ----