Address asciidoctor-dita-vale issues for host collections (#4398)

aneta-petrova · maximiliankolb · web-flow · commit 7ebf93040048 · 2025-10-24T09:55:09.000+02:00
* Split multiple modules into web UI and CLI

* Minor asciidoctor-dita-vale fixes

* Merge overview of collections with assembly intro

This is so that we don't have to write an introduction for the host
collections overview and to make the assembly one module shorter.

* Add abstract role and create basic abstracts

* Turn prereqs into bullet points

---------

Co-authored-by: Maximilian Kolb &lt;mail@maximilian-kolb.de&gt;
diff --git a/guides/common/assembly_configuring-host-collections.adoc b/guides/common/assembly_configuring-host-collections.adoc
@@ -2,17 +2,21 @@
 
 include::modules/con_configuring-host-collections.adoc[]
 
-include::modules/con_host-collections-overview.adoc[leveloffset=+1]
+include::modules/proc_creating-a-host-collection-by-using-web-ui.adoc[leveloffset=+1]
 
-include::modules/proc_creating-a-host-collection.adoc[leveloffset=+1]
+include::modules/proc_creating-a-host-collection-by-using-cli.adoc[leveloffset=+1]
 
 include::modules/proc_cloning-a-host-collection.adoc[leveloffset=+1]
 
 include::modules/proc_removing-a-host-collection.adoc[leveloffset=+1]
 
-include::modules/proc_adding-a-host-to-a-host-collection.adoc[leveloffset=+1]
+include::modules/proc_adding-a-host-to-a-host-collection-by-using-web-ui.adoc[leveloffset=+1]
 
-include::modules/proc_adding-hosts-to-a-host-collection-in-bulk.adoc[leveloffset=+1]
+include::modules/proc_adding-a-host-to-a-host-collection-by-using-cli.adoc[leveloffset=+1]
+
+include::modules/proc_adding-hosts-to-a-host-collection-in-bulk-by-using-web-ui.adoc[leveloffset=+1]
+
+include::modules/proc_adding-hosts-to-a-host-collection-in-bulk-by-using-cli.adoc[leveloffset=+1]
 
 include::modules/proc_removing-a-host-from-a-host-collection.adoc[leveloffset=+1]
 
diff --git a/guides/common/modules/con_adding-content-to-a-host-collection.adoc b/guides/common/modules/con_adding-content-to-a-host-collection.adoc
@@ -3,4 +3,5 @@
 [id="Adding_Content_to_a_Host_Collection_{context}"]
 = Adding content to a host collection
 
+[role="_abstract"]
 These steps show how to add content to host collections in {ProjectName}.
diff --git a/guides/common/modules/con_configuring-host-collections.adoc b/guides/common/modules/con_configuring-host-collections.adoc
@@ -3,4 +3,8 @@
 [id="Configuring_Host_Collections_{context}"]
 = Configuring host collections
 
-With {Project}, you can use host collections to create groups of content hosts.
+[role="_abstract"]
+A host collection in {Project} is a group of hosts.
+With host collections, you can perform the same action on multiple hosts at once.
+These actions include installing, removing, and updating packages, applying errata, and assigning content view environments.
+For example, you can use host collections to group hosts by function, department, or business unit.
diff --git a/guides/common/modules/con_host-collections-overview.adoc b/guides/common/modules/con_host-collections-overview.adoc
diff --git a/guides/common/modules/proc_adding-a-host-to-a-host-collection-by-using-cli.adoc b/guides/common/modules/proc_adding-a-host-to-a-host-collection-by-using-cli.adoc
@@ -0,0 +1,23 @@
+:_mod-docs-content-type: PROCEDURE
+
+[id="adding-a-host-to-a-host-collection-by-using-cli"]
+= Adding a host to a host collection by using Hammer CLI
+
+[role="_abstract"]
+You can add a host to a host collection by using Hammer CLI.
+
+Note that if you add a host to a host collection, the {Project} auditing system does not log the change.
+
+.Prerequisites
+* A host must be registered to {ProjectName} to add it to a Host Collection.
+For more information about registering hosts, see xref:Registering_Hosts_by_Using_Global_Registration_{context}[].
+
+.Procedure
+* Add a host to your host collection:
++
+[options="nowrap", subs="+quotes,attributes"]
+----
+$ hammer host-collection add-host \
+--host-ids _My_Host_ID_ \
+--id _My_Host_Collection_ID_
+----
diff --git a/guides/common/modules/proc_adding-a-host-to-a-host-collection-by-using-web-ui.adoc b/guides/common/modules/proc_adding-a-host-to-a-host-collection-by-using-web-ui.adoc
@@ -1,35 +1,20 @@
 :_mod-docs-content-type: PROCEDURE
 
-[id="adding-a-host-to-a-host-collection_{context}"]
-= Adding a host to a host collection
+[id="adding-a-host-to-a-host-collection-by-using-web-ui"]
+= Adding a host to a host collection by using {ProjectWebUI}
 
+[role="_abstract"]
 You can add a host to a host collection in the {ProjectWebUI}.
 
+Note that if you add a host to a host collection, the {Project} auditing system does not log the change.
+
 .Prerequisites
-ifdef::satellite[]
-A host must be registered to {ProjectName} to add it to a Host Collection.
+* A host must be registered to {ProjectName} to add it to a Host Collection.
 For more information about registering hosts, see xref:Registering_Hosts_by_Using_Global_Registration_{context}[].
-endif::[]
-
-ifndef::satellite[]
-A host must be registered to {ProjectName} to add it to a Host Collection.
-endif::[]
-
-Note that if you add a host to a host collection, the {Project} auditing system does not log the change.
 
 .Procedure
 . In the {ProjectWebUI}, navigate to *Hosts* > *All Hosts*.
 . Click the name of the host you want to modify.
 . In the *Host collections* card, click the vertical ellipsis and select *Add host to collections*.
 . Select the host collection.
 . Click *Add*.
-
-.CLI procedure
-* Add a host to your host collection:
-+
-[options="nowrap", subs="+quotes,attributes"]
-----
-$ hammer host-collection add-host \
---host-ids _My_Host_ID_ \
---id _My_Host_Collection_ID_
-----
diff --git a/guides/common/modules/proc_adding-errata-to-a-host-collection.adoc b/guides/common/modules/proc_adding-errata-to-a-host-collection.adoc
@@ -3,6 +3,7 @@
 [id="Adding_Errata_to_a_Host_Collection_{context}"]
 = Adding errata to a host collection
 
+[role="_abstract"]
 The following procedure shows how to add errata to host collections.
 
 .Prerequisites
diff --git a/guides/common/modules/proc_adding-errata-to-a-host.adoc b/guides/common/modules/proc_adding-errata-to-a-host.adoc
@@ -3,6 +3,7 @@
 [id="Adding_errata_to_a_single_host_{context}"]
 = Adding errata to a single host
 
+[role="_abstract"]
 Use the following procedure to add errata to a host.
 
 .Procedure
diff --git a/guides/common/modules/proc_adding-hosts-to-a-host-collection-in-bulk-by-using-cli.adoc b/guides/common/modules/proc_adding-hosts-to-a-host-collection-in-bulk-by-using-cli.adoc
@@ -0,0 +1,23 @@
+:_mod-docs-content-type: PROCEDURE
+
+[id="adding-hosts-to-a-host-collection-in-bulk-by-using-cli"]
+= Adding hosts to a host collection in bulk by using Hammer CLI
+
+[role="_abstract"]
+You can add multiple hosts to a host collection by using Hammer CLI.
+
+Note that if you add a host to a host collection, the {Project} auditing system does not log the change.
+
+.Prerequisites
+* A host must be registered to {ProjectName} to add it to a host collection.
+For more information about registering hosts, see xref:Registering_Hosts_by_Using_Global_Registration_{context}[].
+
+.Procedure
+* Add multiple hosts to a host collection:
++
+[options="nowrap", subs="+quotes,attributes"]
+----
+$ hammer host-collection add-host \
+--host-ids _My_Host_ID_1_,_My_Host_ID_2_ \
+--id _My_Host_Collection_ID_
+----
diff --git a/guides/common/modules/proc_adding-hosts-to-a-host-collection-in-bulk-by-using-web-ui.adoc b/guides/common/modules/proc_adding-hosts-to-a-host-collection-in-bulk-by-using-web-ui.adoc
@@ -0,0 +1,19 @@
+:_mod-docs-content-type: PROCEDURE
+
+[id="adding-hosts-to-a-host-collection-in-bulk-by-using-web-ui"]
+= Adding hosts to a host collection in bulk by using {ProjectWebUI}
+
+[role="_abstract"]
+You can add multiple hosts to a host collection from {ProjectWebUI}.
+
+Note that if you add a host to a host collection, the {Project} auditing system does not log the change.
+
+.Prerequisites
+* A host must be registered to {ProjectName} to add it to a host collection.
+For more information about registering hosts, see xref:Registering_Hosts_by_Using_Global_Registration_{context}[].
+
+.Procedure
+. In the {ProjectWebUI}, navigate to *Hosts* > *Host Collections*.
+. Select the host collection where the host should be added.
+. On the *Hosts* tab, select the *Add* subtab.
+. Select the hosts to be added from the table and click *Add Selected*.
diff --git a/guides/common/modules/proc_adding-hosts-to-a-host-collection-in-bulk.adoc b/guides/common/modules/proc_adding-hosts-to-a-host-collection-in-bulk.adoc
diff --git a/guides/common/modules/proc_adding-packages-to-a-host-collection.adoc b/guides/common/modules/proc_adding-packages-to-a-host-collection.adoc
@@ -3,6 +3,7 @@
 [id="Adding_Packages_to_a_Host_Collection_{context}"]
 = Adding packages to a host collection
 
+[role="_abstract"]
 The following procedure shows how to add packages to host collections.
 
 .Prerequisites
diff --git a/guides/common/modules/proc_applying-errata-to-hosts-by-using-web-ui.adoc b/guides/common/modules/proc_applying-errata-to-hosts-by-using-web-ui.adoc
@@ -3,6 +3,7 @@
 [id="applying-errata-to-hosts-by-using-web-ui"]
 = Applying errata to hosts by using {ProjectWebUI}
 
+[role="_abstract"]
 You can use {ProjectWebUI} to review and apply errata to hosts.
 
 .Prerequisites
diff --git a/guides/common/modules/proc_changing-the-lifecycle-environment-or-content-view-of-a-host-collection.adoc b/guides/common/modules/proc_changing-the-lifecycle-environment-or-content-view-of-a-host-collection.adoc
@@ -3,6 +3,7 @@
 [id="Changing_the_Lifecycle_Environment_or_Content_View_of_a_Host_Collection_{context}"]
 = Changing the lifecycle environment or content view of a host collection
 
+[role="_abstract"]
 The following procedure shows how to change the assigned lifecycle environment or content view of host collections.
 
 .Procedure
diff --git a/guides/common/modules/proc_cloning-a-host-collection.adoc b/guides/common/modules/proc_cloning-a-host-collection.adoc
@@ -3,6 +3,7 @@
 [id="Cloning_a_Host_Collection_{context}"]
 = Cloning a host collection
 
+[role="_abstract"]
 The following procedure shows how to clone a host collection.
 
 .Procedure
diff --git a/guides/common/modules/proc_creating-a-host-collection-by-using-cli.adoc b/guides/common/modules/proc_creating-a-host-collection-by-using-cli.adoc
@@ -0,0 +1,17 @@
+:_mod-docs-content-type: PROCEDURE
+
+[id="creating-a-host-collection-by-using-cli"]
+= Creating a host collection by using Hammer CLI
+
+[role="_abstract"]
+The following procedure shows how to create host collections by using Hammer CLI.
+
+.Procedure
+* Create a host collection:
++
+[options="nowrap", subs="+quotes,attributes"]
+----
+$ hammer host-collection create \
+--name "_My_Host_Collection_" \
+--organization "_My_Organization_"
+----
diff --git a/guides/common/modules/proc_creating-a-host-collection-by-using-web-ui.adoc b/guides/common/modules/proc_creating-a-host-collection-by-using-web-ui.adoc
@@ -1,9 +1,10 @@
 :_mod-docs-content-type: PROCEDURE
 
-[id="Creating_a_Host_Collection_{context}"]
-= Creating a host collection
+[id="creating-a-host-collection-by-using-web-ui"]
+= Creating a host collection by using {ProjectWebUI}
 
-The following procedure shows how to create host collections.
+[role="_abstract"]
+The following procedure shows how to create host collections from {ProjectWebUI}.
 
 .Procedure
 . In the {ProjectWebUI}, navigate to *Hosts* > *Host Collections*.
@@ -12,13 +13,3 @@ The following procedure shows how to create host collections.
 . Clear *Unlimited Content Hosts*, and enter the desired maximum number of hosts in the *Limit* field.
 . Add the *Description* of the host collection.
 . Click *Save*.
-
-.CLI procedure
-* Create a host collection:
-+
-[options="nowrap", subs="+quotes,attributes"]
-----
-$ hammer host-collection create \
---name "_My_Host_Collection_" \
---organization "_My_Organization_"
-----
diff --git a/guides/common/modules/proc_filter-errata-by-type-severity.adoc b/guides/common/modules/proc_filter-errata-by-type-severity.adoc
@@ -3,6 +3,7 @@
 [id="Filter_errata_by_type_or_severity_{context}"]
 = Filter errata by type and severity
 
+[role="_abstract"]
 Use the following procedure to filter errata by type or severity.
 
 .Procedure
@@ -13,5 +14,5 @@ Use the following procedure to filter errata by type or severity.
 . Click *Severity* to filter by severity.
 . You can filter to display errata of severity N/A, Low, Moderate, Important, or Critical.
 . To deselect your choice, return to the list of options and click the selected option again.
-
++
 You can also use the *Errata* card on the host page to pre-filter errata for type before display.
diff --git a/guides/common/modules/proc_generating-a-report-for-installable-and-applicable-errata.adoc b/guides/common/modules/proc_generating-a-report-for-installable-and-applicable-errata.adoc
@@ -3,6 +3,7 @@
 [id="Generating_a_Report_for_Installable_and_Applicable_Errata_{context}"]
 = Generating a report for installable and applicable errata
 
+[role="_abstract"]
 Use the following procedure to generate a report of installable or applicable errata on hosts.
 
 .Procedure
diff --git a/guides/common/modules/proc_removing-a-host-collection.adoc b/guides/common/modules/proc_removing-a-host-collection.adoc
@@ -3,6 +3,7 @@
 [id="Removing_a_Host_Collection_{context}"]
 = Removing a host collection
 
+[role="_abstract"]
 Use the following procedure to remove a host collection from {Project}.
 
 .Procedure
diff --git a/guides/common/modules/proc_removing-a-host-from-a-host-collection.adoc b/guides/common/modules/proc_removing-a-host-from-a-host-collection.adoc
@@ -3,6 +3,7 @@
 [id="Removing_a_Host_From_a_Host_Collection_{context}"]
 = Removing a host from a host collection
 
+[role="_abstract"]
 The following procedure shows how to remove hosts from host collections.
 
 Note that if you remove a host from a host collection, the host collection record in the database is not modified so the {Project} auditing system does not log the change.
diff --git a/guides/common/modules/proc_removing-a-package-from-a-host.adoc b/guides/common/modules/proc_removing-a-package-from-a-host.adoc
@@ -3,6 +3,7 @@
 [id="Removing_a_package_from_a_host_{context}"]
 = Removing a package from a host
 
+[role="_abstract"]
 Use the following procedure to remove an installed package from a host.
 
 .Procedure
diff --git a/guides/common/modules/proc_removing-content-from-a-host-collection.adoc b/guides/common/modules/proc_removing-content-from-a-host-collection.adoc
@@ -3,6 +3,7 @@
 [id="Removing_Content_From_a_Host_Collection_{context}"]
 = Removing content from a host collection
 
+[role="_abstract"]
 The following procedure shows how to remove packages from host collections.
 
 .Procedure
diff --git a/guides/common/modules/proc_upgrading-a-package.adoc b/guides/common/modules/proc_upgrading-a-package.adoc
@@ -3,6 +3,7 @@
 [id="Upgrading_a_package_{context}"]
 = Upgrading a package
 
+[role="_abstract"]
 Use the following procedure to view the installed packages of a host.
 
 .Procedure
diff --git a/guides/common/modules/proc_viewing-errata-by-applicable-and-installable.adoc b/guides/common/modules/proc_viewing-errata-by-applicable-and-installable.adoc
@@ -3,6 +3,7 @@
 [id="Viewing_Errata_by_Applicable_and_Installable_{context}"]
 = Viewing errata by applicable and installable
 
+[role="_abstract"]
 Use the following procedure to view errata by applicable or installable.
 
 .Procedure
diff --git a/guides/common/modules/proc_viewing-installed-packages.adoc b/guides/common/modules/proc_viewing-installed-packages.adoc
@@ -3,6 +3,7 @@
 [id="Viewing_installed_packages_{context}"]
 = Viewing installed packages
 
+[role="_abstract"]
 Use the following procedure to view the installed packages of a host.
 
 .Procedure
