Reword following command (#4310)

maximiliankolb · Lennonka · commit 44eae9c23877 · 2025-09-30T11:36:45.000+02:00
$ fd -e adoc . guides/common/modules | sort -u | grep -v "guides/common/modules/con_managing-ostree-content.adoc" | rg -v "guides/common/modules/proc_changing-the-method-the-bootstrap-script-uses-to-download-the-consumer-rpm.adoc" | rg -v "guides/common/modules/proc_registering-hosts-by-using-the-bootstrap-script.adoc" | rg -v "guides/common/modules/proc_creating-custom-rhel-images.adoc" | rg -v "guides/common/modules/proc_enabling-remote-execution-on-the-host.adoc" | rg -v "guides/common/modules/proc_registering-clients-using-the-bootstrap-script.adoc" | rg -v "guides/common/modules/proc_enabling-power-management-on-hosts.adoc" | rg -v "guides/common/modules/proc_providing-an-alternative-fqdn-for-the-host.adoc" | rg -v "guides/common/modules/con_managing-ostree-content.adoc" | xargs rg "following command" This patch is the third part. Extends PR #4283 Extends PR #4292 Fixes #3672
diff --git a/guides/common/modules/con_ansible-playbooks.adoc b/guides/common/modules/con_ansible-playbooks.adoc
@@ -19,7 +19,7 @@ In the {ProjectWebUI}, navigate to *Applications > Ansible Playbooks* to manage
 The Ansible Playbook must contain all necessary roles and tasks to execute the playbook.
 
 If your Ansible Playbooks are currently using Ansible collections, ensure that these Ansible collections are added manually to every {SmartProxyServer}.
-To install Ansible collections manually, enter the following command on your {ProjectServer} and {SmartProxyServer}:
+You can install Ansible collections manually on your {ProjectServer} and {SmartProxyServer}:
 
 [options="nowrap", subs="verbatim,quotes,attributes"]
 ----
diff --git a/guides/common/modules/con_important-user-and-group-account-information-for-active-directory-accounts.adoc b/guides/common/modules/con_important-user-and-group-account-information-for-active-directory-accounts.adoc
@@ -10,7 +10,7 @@ All user and group accounts must be local accounts.
 This is to ensure that there are no authentication conflicts between local accounts on your {ProjectServer} and accounts in your Active Directory domain.
 
 Your system is not affected by this conflict if your user and group accounts exist in both `/etc/passwd` and `/etc/group` files.
-For example, to check if entries for `puppet`, `{apache-user}`, `foreman` and `foreman-proxy` groups exist in both `/etc/passwd` and `/etc/group` files, enter the following commands:
+For example, you can check if entries for `puppet`, `{apache-user}`, `foreman` and `foreman-proxy` groups exist in both `/etc/passwd` and `/etc/group` files:
 
 [options="nowrap", subs="+quotes,verbatim,attributes"]
 ----
diff --git a/guides/common/modules/proc_adding-a-host-to-a-host-collection.adoc b/guides/common/modules/proc_adding-a-host-to-a-host-collection.adoc
@@ -25,11 +25,11 @@ Note that if you add a host to a host collection, the {Project} auditing system
 . Click *Add*.
 
 .CLI procedure
-* To add a host to a host collection, enter the following command:
+* Add a host to your host collection:
 +
 [options="nowrap", subs="+quotes,attributes"]
 ----
 $ hammer host-collection add-host \
---host-ids _My_Host_ID_1_ \
+--host-ids _My_Host_ID_ \
 --id _My_Host_Collection_ID_
 ----
diff --git a/guides/common/modules/proc_adding-a-subnet.adoc b/guides/common/modules/proc_adding-a-subnet.adoc
@@ -38,7 +38,7 @@ For example, user defined Boolean or string parameters to use in templates.
 
 [id="cli-adding-a-subnet_{context}"]
 .CLI procedure
-* Create the subnet with the following command:
+* Create a subnet:
 +
 [options="nowrap" subs="+quotes,attributes"]
 ----
diff --git a/guides/common/modules/proc_adding-custom-deb-repositories.adoc b/guides/common/modules/proc_adding-custom-deb-repositories.adoc
@@ -66,7 +66,7 @@ By default, the repository is published through HTTP.
 
 [id="cli-adding-custom-deb-repositories"]
 .CLI procedure
-. Enter the following command to create the repository:
+. Create a Deb repository:
 +
 [options="nowrap" subs="+quotes"]
 ----
@@ -83,4 +83,5 @@ $ hammer repository create \
 --url _My_Upstream_URL_
 ----
 
-Continue to xref:Synchronizing_Repositories_{context}[synchronize the repository].
+.Next steps
+* xref:Synchronizing_Repositories_{context}[]
diff --git a/guides/common/modules/proc_adding-custom-rpm-repositories.adoc b/guides/common/modules/proc_adding-custom-rpm-repositories.adoc
@@ -59,7 +59,7 @@ By default, the repository is published through HTTP.
 
 [id="cli-adding-custom-rpm-repositories"]
 .CLI procedure
-. Enter the following command to create the repository:
+. Create a Yum repository:
 +
 [options="nowrap" subs="+quotes"]
 ----
@@ -75,4 +75,5 @@ $ hammer repository create \
 --url _My_Upstream_URL_
 ----
 
-Continue to xref:Synchronizing_Repositories_{context}[synchronize the repository].
+.Next steps
+* xref:Synchronizing_Repositories_{context}[]
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
@@ -24,7 +24,7 @@ Note that if you add a host to a host collection, the {Project} auditing system
 . Select the hosts to be added from the table and click *Add Selected*.
 
 .CLI procedure
-* To add multiple hosts to a host collection, enter the following command:
+* Add multiple hosts to a host collection:
 +
 [options="nowrap", subs="+quotes,attributes"]
 ----
diff --git a/guides/common/modules/proc_adding-kvm-details-to-a-compute-profile.adoc b/guides/common/modules/proc_adding-kvm-details-to-a-compute-profile.adoc
@@ -25,21 +25,20 @@ You can create multiple volumes for the host.
 
 [id="cli-adding-kvm-details-to-a-compute-profile_{context}"]
 .CLI procedure
-
-. To create a compute profile, enter the following command:
+. Create a compute profile:
 +
 [options="nowrap" subs="+quotes"]
 ----
-$ hammer compute-profile create --name "Libvirt CP"
+$ hammer compute-profile create --name "_My_Libvirt_Compute_Profile_"
 ----
-+
-. To add the values for the compute profile, enter the following command:
+. Add values to your compute profile:
 +
 [options="nowrap" subs="+quotes"]
 ----
-$ hammer compute-profile values create --compute-profile "Libvirt CP" \
+$ hammer compute-profile values create \
+--compute-attributes "cpus=1,memory=1073741824" \
+--compute-profile "_My_Libvirt_Compute_Profile_" \
 --compute-resource "_My_KVM_Server_" \
 --interface "compute_type=network,compute_model=virtio,compute_network=_examplenetwork_" \
---volume "pool_name=default,capacity=20G,format_type=qcow2" \
---compute-attributes "cpus=1,memory=1073741824"
+--volume "pool_name=default,capacity=20G,format_type=qcow2"
 ----
diff --git a/guides/common/modules/proc_anonymizing-audit-records.adoc b/guides/common/modules/proc_anonymizing-audit-records.adoc
@@ -9,7 +9,7 @@ You can also use a cron job to schedule anonymizing the audit records at the set
 By default, using the `foreman-rake audits:anonymize` command anonymizes audit records that are older than 90 days.
 You can specify the number of days to keep the audit records by adding the *days* option and add the number of days.
 
-For example, if you want to anonymize audit records that are older than seven days, enter the following command:
+For example, you can anonymize audit records that are older than seven days:
 
 ----
 # foreman-rake audits:anonymize days=7
diff --git a/guides/common/modules/proc_assigning-a-puppet-class-to-an-individual-host.adoc b/guides/common/modules/proc_assigning-a-puppet-class-to-an-individual-host.adoc
@@ -46,15 +46,15 @@ Other operating systems may store the ntp config file in a different path.
 +
 [TIP]
 ====
-You may need to run the Puppet agent on your host by executing the following command:
+You can rerun the Puppet agent on your host:
 
 [options="nowrap", subs="verbatim,quotes,attributes"]
 ----
 # puppet agent -t
 ----
 ====
 
-. Running the following command on the host checks which ntp servers are used for clock synchronization:
+. Check which ntp servers are used for clock synchronization:
 +
 [options="nowrap", subs="verbatim,quotes,attributes"]
 ----
diff --git a/guides/common/modules/proc_assigning-roles-to-a-user.adoc b/guides/common/modules/proc_assigning-roles-to-a-user.adoc
@@ -28,9 +28,11 @@ To remove an assigned role, click the role name in *Selected items*.
 
 [id="cli-assigning-roles-to-a-user_{context}"]
 .CLI procedure
-* To assign roles to a user, enter the following command:
+* Assign roles to a user:
 +
 [options="nowrap", subs="+quotes,attributes"]
 ----
-$ hammer user add-role --id _user_id_ --role _role_name_
+$ hammer user add-role \
+--id _My_User_ID_ \
+--role _My_Role_Name_
 ----
diff --git a/guides/common/modules/proc_authenticating-hammer-using-sessions.adoc b/guides/common/modules/proc_authenticating-hammer-using-sessions.adoc
@@ -12,38 +12,39 @@ See the instructions on how to use the sessions:
 
 * To enable sessions, add `:use_sessions: true` to the `~/.hammer/cli.modules.d/foreman.yml` file:
 +
+[source, yaml, options="nowrap", subs="+quotes,verbatim,attributes"]
 ----
 :foreman:
  :use_sessions: true
 ----
 Note that if you enable sessions, credentials stored in the configuration file will be ignored.
+* Start a session:
 +
-* To start a session, enter the following command:
-+
+[options="nowrap", subs="+quotes,verbatim,attributes"]
 ----
 $ hammer auth login
 ----
 +
 You are prompted for your {Project} credentials, and logged in.
 You will not be prompted for the credentials again until your session expires.
-+
 * The default length of a session is 60 minutes.
-You can change the time to suit your preference.
-For example, to change it to 30 minutes, enter the following command:
+You can change the time to suit your preference, for example, 30 minutes:
 +
+[options="nowrap", subs="+quotes,verbatim,attributes"]
 ----
-$ hammer settings set --name idle_timeout --value 30
-Setting [idle_timeout] updated to [30]
+$ hammer settings set \
+--name idle_timeout \
+--value 30
 ----
+* View the current status of the session:
 +
-* To see the current status of the session, enter the following command:
-+
+[options="nowrap", subs="+quotes,verbatim,attributes"]
 ----
 $ hammer auth status
 ----
+* End the session:
 +
-* To end the session, enter the following command:
-+
+[options="nowrap", subs="+quotes,verbatim,attributes"]
 ----
 $ hammer auth logout
 ----
diff --git a/guides/common/modules/proc_changing-the-http-proxy-policy-for-a-repository.adoc b/guides/common/modules/proc_changing-the-http-proxy-policy-for-a-repository.adoc
@@ -22,7 +22,7 @@ For more information, see xref:Adding_an_HTTP_Proxy_{context}[].
 
 [id="cli-Changing_the_HTTP_Proxy_Policy_for_a_Repository_{context}"]
 .CLI procedure
-* On {ProjectServer}, enter the following command, specifying the HTTP proxy policy you want to use:
+* On {ProjectServer}, specify the HTTP proxy policy you want to use:
 +
 [subs="+quotes"]
 ----
diff --git a/guides/common/modules/proc_configuring-custom-alternate-content-sources.adoc b/guides/common/modules/proc_configuring-custom-alternate-content-sources.adoc
@@ -25,7 +25,7 @@ For example, if your base URL is `\https://{server-example-com}` and your subpat
 
 [id="cli-configuring-custom-alternate-content-sources_{context}"]
 .CLI procedure
-. On {ProjectServer}, enter the following command:
+. Configure a custom alternate content source:
 +
 [options="nowrap" subs="+quotes,attributes"]
 ----
diff --git a/guides/common/modules/proc_configuring-external-user-groups.adoc b/guides/common/modules/proc_configuring-external-user-groups.adoc
@@ -23,7 +23,7 @@ You must use either an anonymous or dedicated service user.
 For more information, see {ConfiguringUserAuthenticationDocURL}[_{ConfiguringUserAuthenticationDocTitle}_].
 * Ensure that at least one external user authenticates for the first time.
 * Retain a copy of the external group names you want to use.
-To find the group membership of external users, enter the following command:
+You can find the group membership of external users:
 +
 [options="nowrap", subs="+quotes,verbatim,attributes"]
 ----
diff --git a/guides/common/modules/proc_configuring-kerberos-authentication-for-remote-execution.adoc b/guides/common/modules/proc_configuring-kerberos-authentication-for-remote-execution.adoc
@@ -12,7 +12,7 @@ You can use Kerberos authentication to establish an SSH connection for remote ex
 * Ensure that the `foreman-proxy` user on {Project} has a valid Kerberos ticket-granting ticket (TGT)
 
 .Procedure
-. To install and enable Kerberos authentication for remote execution, enter the following command:
+. Enable Kerberos authentication for remote execution:
 +
 [options="nowrap", subs="+quotes,verbatim,attributes"]
 ----
diff --git a/guides/common/modules/proc_configuring-project-with-an-alternate-cname.adoc b/guides/common/modules/proc_configuring-project-with-an-alternate-cname.adoc
@@ -7,7 +7,7 @@ Use this procedure to configure {Project} with an alternate CNAME.
 Note that the procedures for users of a default {Project} certificate and custom certificate differ.
 
 .For default {Project} certificate users
-* If you have installed {Project} with a default {Project} certificate and want to configure {Project} with an alternate CNAME, enter the following command on {Project} to generate a new default {Project} SSL certificate with an additional CNAME.
+* If you have installed {Project} with a default {Project} certificate and want to configure {Project} with an alternate CNAME, generate a new default {Project} SSL certificate with an additional CNAME on {ProjectServer}:
 +
 [options="nowrap" subs="+quotes,attributes"]
 ----
diff --git a/guides/common/modules/proc_configuring-provisioning-callback-for-a-host.adoc b/guides/common/modules/proc_configuring-provisioning-callback-for-a-host.adoc
@@ -83,13 +83,13 @@ If unsure, check the API endpoints of your instance to verify the correct path.
 +
 . Click *Submit*.
 . Create a host using the host group.
-. On the new host, enter the following command to start the `ansible-callback` service:
+. On your new host, start the `ansible-callback` service:
 +
 [options="nowrap", subs="+quotes,verbatim,attributes"]
 ----
 # systemctl start ansible-callback
 ----
-. On the new host, enter the following command to output the status of the `ansible-callback` service:
+. On your new host, check the the status of the `ansible-callback` service:
 +
 [options="nowrap", subs="+quotes,verbatim,attributes"]
 ----
diff --git a/guides/common/modules/proc_configuring-server-for-kvm-connections.adoc b/guides/common/modules/proc_configuring-server-for-kvm-connections.adoc
@@ -6,40 +6,34 @@
 Before adding the KVM connection, create an SSH key pair for the `foreman` user to ensure a secure connection between {ProjectServer} and KVM.
 
 .Procedure
-
 . On {ProjectServer}, switch to the `foreman` user:
 +
 ----
 # su foreman -s /bin/bash
 ----
-
 . Generate the key pair:
 +
 ----
 $ ssh-keygen
 ----
-
 . Copy the public key to the KVM server:
 +
 [options="nowrap" subs="+quotes"]
 ----
 $ ssh-copy-id _root@kvm.example.com_
 ----
-
 . Exit the bash shell for the `foreman` user:
 +
 ----
 $ exit
 ----
-
 . Install the `libvirt-client` package:
 +
 [options="nowrap" subs="+quotes,attributes"]
 ----
 # {project-package-install} libvirt-client
 ----
-+
-. Use the following command to test the connection to the KVM server:
+. Test the connection to the KVM server:
 +
 [options="nowrap"]
 ----
diff --git a/guides/common/modules/proc_configuring-the-fallback-to-any-smartproxy-remote-execution-setting-in-project.adoc b/guides/common/modules/proc_configuring-the-fallback-to-any-smartproxy-remote-execution-setting-in-project.adoc
@@ -22,8 +22,7 @@ If the *Fallback to Any {SmartProxy}* setting is enabled, {Project} adds another
 . Configure the *Fallback to Any {SmartProxy}* setting.
 
 .CLI procedure
-* Enter the `hammer settings set` command on {Project} to configure the *Fallback to Any {SmartProxy}* setting.
-To set the value to `true`, enter the following command:
+* Configure the *Fallback to Any {SmartProxy}* setting:
 +
 [options="nowrap", subs="+quotes,verbatim,attributes"]
 ----
diff --git a/guides/common/modules/proc_creating-a-complete-permission-table.adoc b/guides/common/modules/proc_creating-a-complete-permission-table.adoc
@@ -16,7 +16,7 @@ ifndef::satellite[]
 endif::[]
 
 .Procedure
-. Start the {Project} console with the following command:
+. Start the {Project} console:
 +
 [options="nowrap", subs="+quotes,verbatim,attributes"]
 ----
diff --git a/guides/common/modules/proc_creating-a-custom-product.adoc b/guides/common/modules/proc_creating-a-custom-product.adoc
@@ -20,13 +20,11 @@ To use the CLI instead of the {ProjectWebUI}, see the xref:cli-creating-a-custom
 
 [id="cli-creating-a-custom-product"]
 .CLI procedure
-To create the product, enter the following command:
-
+* Create a product:
++
 [options="nowrap" subs="+quotes"]
 ----
 $ hammer product create \
---name "_My_Product_" \
---sync-plan "_Example Plan_" \
---description "_Content from My Repositories_" \
---organization "_My_Organization_"
+--name "_My_Name_" \
+--organization-id _My_Organization_ID_
 ----
diff --git a/guides/common/modules/proc_creating-a-sync-plan.adoc b/guides/common/modules/proc_creating-a-sync-plan.adoc
@@ -13,12 +13,12 @@ To use the CLI instead of the {ProjectWebUI}, see the xref:cli-creating-a-sync-p
 . In the *Name* field, enter a name for the plan.
 . Optional: In the *Description* field, enter a description of the plan.
 . From the *Interval* list, select the interval at which you want the plan to run.
-. From the *Start Date* and *Start Time* lists, select when to start running the synchronization plan.
+. From the *Start Date* and *Start Time* lists, select when to start running the sync plan.
 . Click *Save*.
 
 [id="cli-creating-a-sync-plan"]
 .CLI procedure
-. To create the synchronization plan, enter the following command:
+. Create a sync plan:
 +
 [options="nowrap" subs="+quotes"]
 ----
diff --git a/guides/common/modules/proc_creating-a-user-group.adoc b/guides/common/modules/proc_creating-a-user-group.adoc
@@ -16,7 +16,7 @@ Alternatively, select the *Admin* checkbox to assign all available permissions.
 . Click *Submit*.
 
 .CLI procedure
-* To create a user group, enter the following command:
+* Create a user group:
 +
 [options="nowrap", subs="+quotes,attributes"]
 ----
diff --git a/guides/common/modules/proc_deleting-a-location.adoc b/guides/common/modules/proc_deleting-a-location.adoc
@@ -22,15 +22,15 @@ There must be at least one location in the environment at any given time.
 . Click *OK* to delete the location.
 
 .CLI procedure
-. Enter the following command to retrieve the ID of the location that you want to delete:
+. View all locations:
 +
 [subs="+quotes"]
 ----
 $ hammer location list
 ----
 +
 From the output, note the ID of the location that you want to delete.
-. Enter the following command to delete the location:
+. Delete a location:
 +
 [subs="+quotes"]
 ----
diff --git a/guides/common/modules/proc_deleting-an-organization.adoc b/guides/common/modules/proc_deleting-an-organization.adoc
diff --git a/guides/common/modules/proc_distributing-ssh-keys-for-remote-execution-manually.adoc b/guides/common/modules/proc_distributing-ssh-keys-for-remote-execution-manually.adoc
diff --git a/guides/common/modules/proc_formatting-hammer-output.adoc b/guides/common/modules/proc_formatting-hammer-output.adoc
diff --git a/guides/common/modules/proc_importing-a-repository-from-a-web-server.adoc b/guides/common/modules/proc_importing-a-repository-from-a-web-server.adoc
diff --git a/guides/common/modules/proc_testing-email-notifications.adoc b/guides/common/modules/proc_testing-email-notifications.adoc
diff --git a/guides/common/modules/proc_uploading-content-to-custom-rpm-repositories.adoc b/guides/common/modules/proc_uploading-content-to-custom-rpm-repositories.adoc

Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ For example, user defined Boolean or string parameters to use in templates.`
`38`	`38`
`39`	`39`	`[id="cli-adding-a-subnet_{context}"]`
`40`	`40`	`.CLI procedure`
`41`		`-* Create the subnet with the following command:`
	`41`	`+* Create a subnet:`
`42`	`42`	`+`
`43`	`43`	`[options="nowrap" subs="+quotes,attributes"]`
`44`	`44`	`----`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ Note that if you add a host to a host collection, the {Project} auditing system`
`24`	`24`	`. Select the hosts to be added from the table and click Add Selected.`
`25`	`25`
`26`	`26`	`.CLI procedure`
`27`		`-* To add multiple hosts to a host collection, enter the following command:`
	`27`	`+* Add multiple hosts to a host collection:`
`28`	`28`	`+`
`29`	`29`	`[options="nowrap", subs="+quotes,attributes"]`
`30`	`30`	`----`