From fd91a2acd89be828cfed9d3ce3a96acbc75f620a Mon Sep 17 00:00:00 2001 From: Maxim Svistunov Date: Tue, 22 Oct 2024 16:39:35 +0200 Subject: [PATCH 1/2] Change "OS" to "operating system" per RHSSG --- .../modules/con_restricting-hosts-access-to-content.adoc | 2 +- guides/common/modules/con_supported-ansible-versions.adoc | 2 +- .../common/modules/proc_adding-custom-rpm-repositories.adoc | 6 +++--- .../modules/proc_configuring-repositories-foreman-deb.adoc | 2 +- ...reating-a-host-group-for-each-lifecycle-environment.adoc | 2 +- .../proc_deploying-ssh-keys-during-provisioning.adoc | 2 +- .../proc_determining-hardware-and-os-configuration.adoc | 4 ++-- guides/common/modules/proc_importing-templates.adoc | 4 ++-- ...to-a-specific-os-version-or-architecture-in-project.adoc | 2 +- ...proc_synchronizing-templates-with-a-local-directory.adoc | 4 ++-- .../modules/proc_upgrading-a-connected-project-server.adoc | 2 +- ...roc_upgrading-project-or-proxy-in-place-using-leapp.adoc | 2 +- .../modules/ref_required-boot-order-for-network-boot.adoc | 2 +- guides/common/modules/ref_template-sync-settings.adoc | 2 +- .../topics/Provisioning_Concepts.adoc | 2 +- guides/doc-Quickstart/master.adoc | 2 +- 16 files changed, 21 insertions(+), 21 deletions(-) diff --git a/guides/common/modules/con_restricting-hosts-access-to-content.adoc b/guides/common/modules/con_restricting-hosts-access-to-content.adoc index afe1b8b2e52..f5d624c0c8f 100644 --- a/guides/common/modules/con_restricting-hosts-access-to-content.adoc +++ b/guides/common/modules/con_restricting-hosts-access-to-content.adoc @@ -51,7 +51,7 @@ Red{nbsp}Hat repositories set architecture and operating system version restrict endif::[] endif::[] ifndef::orcharhino[] -Red{nbsp}Hat repositories set architecture and OS version restrictions automatically. +Red{nbsp}Hat repositories set architecture and operating system version restrictions automatically. Release version:: Certain Red{nbsp}Hat repositories, such as the {RHEL} dot release repositories, include a *Release version* in their repository metadata. diff --git a/guides/common/modules/con_supported-ansible-versions.adoc b/guides/common/modules/con_supported-ansible-versions.adoc index 650fa4b40a7..3bd6bdc9cc5 100644 --- a/guides/common/modules/con_supported-ansible-versions.adoc +++ b/guides/common/modules/con_supported-ansible-versions.adoc @@ -2,4 +2,4 @@ = Supported Ansible versions {Project} uses Ansible as provided by the base operating system of {ProjectServer} or any {SmartProxies} for remote execution. -Therefore, the supported version of Ansible depends on your base OS configuration. +Therefore, the supported version of Ansible depends on your base operating system configuration. diff --git a/guides/common/modules/proc_adding-custom-rpm-repositories.adoc b/guides/common/modules/proc_adding-custom-rpm-repositories.adoc index 90789ed58fc..ecb02a3d4de 100644 --- a/guides/common/modules/proc_adding-custom-rpm-repositories.adoc +++ b/guides/common/modules/proc_adding-custom-rpm-repositories.adoc @@ -23,8 +23,8 @@ endif::[] . From the *Type* list, select `yum` as type of repository. . Optional: From the *Restrict to Architecture* list, select an architecture. If you want to make the repository available to all hosts regardless of the architecture, ensure to select *No restriction*. -. Optional: From the *Restrict to OS Version* list, select the OS version. -If you want to make the repository available to all hosts regardless of the OS version, ensure to select *No restriction*. +. Optional: From the *Restrict to OS Version* list, select the operating system version. +If you want to make the repository available to all hosts regardless of the operating system version, ensure to select *No restriction*. . Optional: In the *Upstream URL* field, enter the URL of the external repository to use as a source. {Project} supports three protocols: `http://`, `https://`, and `file://`. If you are using a `file://` repository, you have to place it under `/var/lib/pulp/sync_imports/` directory. @@ -67,7 +67,7 @@ By default, the repository is published through HTTP. --gpg-key-id _My_GPG_Key_ID_ \ --name "_My_Repository_" \ --organization "_My_Organization_" \ ---os-version "_My_OS_Version_" \ +--os-version "_My_Operating_System_Version_" \ --product "_My_Product_" \ --publish-via-http true \ --url _My_Upstream_URL_ diff --git a/guides/common/modules/proc_configuring-repositories-foreman-deb.adoc b/guides/common/modules/proc_configuring-repositories-foreman-deb.adoc index 00da2797084..cd6bbdb0585 100644 --- a/guides/common/modules/proc_configuring-repositories-foreman-deb.adoc +++ b/guides/common/modules/proc_configuring-repositories-foreman-deb.adoc @@ -1,6 +1,6 @@ .Procedure -// List of supported OS for foreman-deb has to match "guides/common/modules/proc_upgrading-a-connected-project-server.adoc" +// List of supported operating systems for foreman-deb has to match "guides/common/modules/proc_upgrading-a-connected-project-server.adoc" [tabs] ===== Debian 11 (Bullseye):: diff --git a/guides/common/modules/proc_creating-a-host-group-for-each-lifecycle-environment.adoc b/guides/common/modules/proc_creating-a-host-group-for-each-lifecycle-environment.adoc index ad00d6e1d0a..91f774bfb85 100644 --- a/guides/common/modules/proc_creating-a-host-group-for-each-lifecycle-environment.adoc +++ b/guides/common/modules/proc_creating-a-host-group-for-each-lifecycle-environment.adoc @@ -8,7 +8,7 @@ To create a host group for each lifecycle environment, run the following Bash sc [source,terminal,options="nowrap" subs="+quotes"] ---- -MAJOR="_My_Major_OS_Version_" +MAJOR="_My_Major_Operating_System_Version_" ARCH="_My_Architecture_" ORG="_My_Organization_" LOCATIONS="_My_Location_" diff --git a/guides/common/modules/proc_deploying-ssh-keys-during-provisioning.adoc b/guides/common/modules/proc_deploying-ssh-keys-during-provisioning.adoc index 442a44b470a..6704dd05339 100644 --- a/guides/common/modules/proc_deploying-ssh-keys-during-provisioning.adoc +++ b/guides/common/modules/proc_deploying-ssh-keys-during-provisioning.adoc @@ -18,7 +18,7 @@ For more information, see xref:creating-provisioning-templates_{context}[]. . Click the *Association* tab. . From the *Application Operating Systems* list, select an operating system. . Click *Submit* to save the provisioning template. -. Create a host that is associated with the provisioning template or rebuild a host using the OS associated with the modified template. +. Create a host that is associated with the provisioning template or rebuild a host using the operating system associated with the modified template. For more information, see {ManagingHostsDocURL}Creating_a_Host_managing-hosts[Creating a Host] in _{ManagingHostsDocTitle}_. + The SSH keys of the *Owned by* user are added automatically when the `create_users` snippet is executed during the provisioning process. diff --git a/guides/common/modules/proc_determining-hardware-and-os-configuration.adoc b/guides/common/modules/proc_determining-hardware-and-os-configuration.adoc index 691d20e8238..960437b318b 100644 --- a/guides/common/modules/proc_determining-hardware-and-os-configuration.adoc +++ b/guides/common/modules/proc_determining-hardware-and-os-configuration.adoc @@ -1,5 +1,5 @@ -[id="Determining_Hardware_and_OS_Configuration_{context}"] -= Determining hardware and OS configuration +[id="Determining_Hardware_and_operating_system_Configuration_{context}"] += Determining hardware and operating system configuration CPU:: The more physical cores that are available to {Project}, the higher throughput can be achieved for the tasks. diff --git a/guides/common/modules/proc_importing-templates.adoc b/guides/common/modules/proc_importing-templates.adoc index 9bc998a339f..9237146e1a3 100644 --- a/guides/common/modules/proc_importing-templates.adoc +++ b/guides/common/modules/proc_importing-templates.adoc @@ -21,8 +21,8 @@ Before you import a template, ensure that you add the following section to the t kind: provision name: _My_Provisioning_Template_ oses: -- _My_first_OS_ -- _My_second_OS_ +- _My_first_Operating_System_ +- _My_second_Operating_System_ locations: - _My_first_Location_ - _My_second_Location_ diff --git a/guides/common/modules/proc_restricting-customrepoid-to-a-specific-os-version-or-architecture-in-project.adoc b/guides/common/modules/proc_restricting-customrepoid-to-a-specific-os-version-or-architecture-in-project.adoc index 63446b35395..33ed6cf782b 100644 --- a/guides/common/modules/proc_restricting-customrepoid-to-a-specific-os-version-or-architecture-in-project.adoc +++ b/guides/common/modules/proc_restricting-customrepoid-to-a-specific-os-version-or-architecture-in-project.adoc @@ -1,4 +1,4 @@ -[id="Restricting_a_{customrepoid}_to_a_Specific_OS_Version_or_Architecture_in_Project_{context}"] +[id="Restricting_a_{customrepoid}_to_a_Specific_operating_system_Version_or_Architecture_in_Project_{context}"] = Restricting a {customrepo} to a specific operating system or architecture in {Project} You can configure {Project} to make a {customrepo} available only on hosts with a specific operating system version or architecture. diff --git a/guides/common/modules/proc_synchronizing-templates-with-a-local-directory.adoc b/guides/common/modules/proc_synchronizing-templates-with-a-local-directory.adoc index c5e5d5d2649..5e6907ee891 100644 --- a/guides/common/modules/proc_synchronizing-templates-with-a-local-directory.adoc +++ b/guides/common/modules/proc_synchronizing-templates-with-a-local-directory.adoc @@ -16,8 +16,8 @@ Before you import a template, ensure that you add the following section to the t kind: provision name: _My_Provisioning_Template_ oses: -- _My_first_OS_ -- _My_second_OS_ +- _My_first_Operating_System_ +- _My_second_Operating_System_ locations: - _My_first_Location_ - _My_second_Location_ diff --git a/guides/common/modules/proc_upgrading-a-connected-project-server.adoc b/guides/common/modules/proc_upgrading-a-connected-project-server.adoc index 1261abdac79..ce2676354c2 100644 --- a/guides/common/modules/proc_upgrading-a-connected-project-server.adoc +++ b/guides/common/modules/proc_upgrading-a-connected-project-server.adoc @@ -93,7 +93,7 @@ deb http://deb.theforeman.org/ _My_Distribution_Code_Name_ {ProjectVersion} deb http://deb.theforeman.org/ plugins {ProjectVersion} ---- + -// List of supported OS for foreman-deb has to match "guides/common/modules/proc_configuring-repositories-foreman-deb.adoc" +// List of supported operating systems for foreman-deb has to match "guides/common/modules/proc_configuring-repositories-foreman-deb.adoc" Replace _My_Distribution_Code_Name_ with the proper distribution code name based on the operating system of your {ProjectServer}: + * `bullseye` for Debian 11 diff --git a/guides/common/modules/proc_upgrading-project-or-proxy-in-place-using-leapp.adoc b/guides/common/modules/proc_upgrading-project-or-proxy-in-place-using-leapp.adoc index 30b48c835f9..e9e0e14a5bd 100644 --- a/guides/common/modules/proc_upgrading-project-or-proxy-in-place-using-leapp.adoc +++ b/guides/common/modules/proc_upgrading-project-or-proxy-in-place-using-leapp.adoc @@ -84,7 +84,7 @@ baseurl=http://_server.example.com_/sat6/Maintenance/ endif::[] endif::[] ifndef::satellite[] -. Install additional OS specific packages (`leapp-data-almalinux` for AlmaLinux, `leapp-data-centos` for CentOS Stream, or `leapp-data-rocky` for Rocky Linux). +. Install additional packages specific to the operating system (`leapp-data-almalinux` for AlmaLinux, `leapp-data-centos` for CentOS Stream, or `leapp-data-rocky` for Rocky Linux). See `ID` in `/etc/os-release` for your operating system code. + [options="nowrap", subs="+quotes,verbatim,attributes"] diff --git a/guides/common/modules/ref_required-boot-order-for-network-boot.adoc b/guides/common/modules/ref_required-boot-order-for-network-boot.adoc index 36c62ff5e57..55198819236 100644 --- a/guides/common/modules/ref_required-boot-order-for-network-boot.adoc +++ b/guides/common/modules/ref_required-boot-order-for-network-boot.adoc @@ -10,5 +10,5 @@ For physical or virtual BIOS hosts:: For physical or virtual EFI hosts:: . Set the first booting device as boot configuration with network. -. Depending on the EFI firmware type and configuration, the OS installer typically configures the OS boot loader as the first entry. +. Depending on the EFI firmware type and configuration, the operating system installer typically configures the operating system boot loader as the first entry. . To reboot into installer again, use the `efibootmgr` utility to switch back to boot from network. diff --git a/guides/common/modules/ref_template-sync-settings.adoc b/guides/common/modules/ref_template-sync-settings.adoc index 7a6f9b712dd..875a654e22b 100644 --- a/guides/common/modules/ref_template-sync-settings.adoc +++ b/guides/common/modules/ref_template-sync-settings.adoc @@ -4,7 +4,7 @@ [cols="30%,30%,40%",options="header"] |==== | Setting | Default Value | Description -| *Associate* | New | Associate templates with OS, organization and location. +| *Associate* | New | Associate templates with operating system, organization and location. | *Branch* | | Default branch in Git repo. | *Commit message* | Templates export made by a {Project} user | Custom commit message for exported templates. | *Dirname* | / | The directory within the Git repo containing the templates. diff --git a/guides/doc-Planning_for_Project/topics/Provisioning_Concepts.adoc b/guides/doc-Planning_for_Project/topics/Provisioning_Concepts.adoc index 6e04c739563..21dc5288518 100644 --- a/guides/doc-Planning_for_Project/topics/Provisioning_Concepts.adoc +++ b/guides/doc-Planning_for_Project/topics/Provisioning_Concepts.adoc @@ -142,7 +142,7 @@ To perform the Secure Boot, the boot loader must be manually signed and key enro Alternatively, grub2 from Ubuntu or {EL} can be copied to perform booting. Grub2 in {EL} 8.0-8.3 were updated to mitigate https://access.redhat.com/security/vulnerabilities/grub2bootloader[Boot Hole Vulnerability] and keys of existing {EL} kernels were invalidated. -To boot any of the affected {EL} kernel (or OS installer), you must enroll keys manually into the EFI firmware for each host: +To boot any of the affected {EL} kernel (or operating system installer), you must enroll keys manually into the EFI firmware for each host: + [options="nowrap" subs="+quotes,attributes"] ---- diff --git a/guides/doc-Quickstart/master.adoc b/guides/doc-Quickstart/master.adoc index 823eb433f43..960f95c2dee 100644 --- a/guides/doc-Quickstart/master.adoc +++ b/guides/doc-Quickstart/master.adoc @@ -8,7 +8,7 @@ include::common/header.adoc[] = {QuickstartDocTitle} The Foreman installer is a collection of Puppet modules that installs everything required for a full working Foreman setup. -It uses native OS packaging (`.rpm` or `.deb` packages) and adds necessary configuration for the complete installation. +It uses native operating system packaging (`.rpm` or `.deb` packages) and adds necessary configuration for the complete installation. Components include the Foreman web UI, Smart Proxy, a Puppet server, TFTP, DNS and DHCP servers. It is configurable and the Puppet modules can be read or run in "no-op" mode to see what changes it will make. From 34f0dd0875331c8c9b73ef782d7d36c3cede728e Mon Sep 17 00:00:00 2001 From: Maxim Svistunov Date: Mon, 4 Nov 2024 10:56:46 +0100 Subject: [PATCH 2/2] Match filenames to new titles and IDs --- guides/common/assembly_importing-content.adoc | 2 +- ...etermining-hardware-and-operating-system-configuration.adoc} | 0 ...ic-operating-system-version-or-architecture-in-project.adoc} | 0 guides/doc-Tuning_Performance/master.adoc | 2 +- 4 files changed, 2 insertions(+), 2 deletions(-) rename guides/common/modules/{proc_determining-hardware-and-os-configuration.adoc => proc_determining-hardware-and-operating-system-configuration.adoc} (100%) rename guides/common/modules/{proc_restricting-customrepoid-to-a-specific-os-version-or-architecture-in-project.adoc => proc_restricting-customrepoid-to-a-specific-operating-system-version-or-architecture-in-project.adoc} (100%) diff --git a/guides/common/assembly_importing-content.adoc b/guides/common/assembly_importing-content.adoc index 3167e3d555d..7e240c51f1e 100644 --- a/guides/common/assembly_importing-content.adoc +++ b/guides/common/assembly_importing-content.adoc @@ -206,4 +206,4 @@ include::modules/proc_limiting-synchronization-concurrency.adoc[leveloffset=+1] include::modules/proc_importing-a-custom-gpg-key.adoc[leveloffset=+1] -include::modules/proc_restricting-customrepoid-to-a-specific-os-version-or-architecture-in-project.adoc[leveloffset=+1] +include::modules/proc_restricting-customrepoid-to-a-specific-operating-system-version-or-architecture-in-project.adoc[leveloffset=+1] diff --git a/guides/common/modules/proc_determining-hardware-and-os-configuration.adoc b/guides/common/modules/proc_determining-hardware-and-operating-system-configuration.adoc similarity index 100% rename from guides/common/modules/proc_determining-hardware-and-os-configuration.adoc rename to guides/common/modules/proc_determining-hardware-and-operating-system-configuration.adoc diff --git a/guides/common/modules/proc_restricting-customrepoid-to-a-specific-os-version-or-architecture-in-project.adoc b/guides/common/modules/proc_restricting-customrepoid-to-a-specific-operating-system-version-or-architecture-in-project.adoc similarity index 100% rename from guides/common/modules/proc_restricting-customrepoid-to-a-specific-os-version-or-architecture-in-project.adoc rename to guides/common/modules/proc_restricting-customrepoid-to-a-specific-operating-system-version-or-architecture-in-project.adoc diff --git a/guides/doc-Tuning_Performance/master.adoc b/guides/doc-Tuning_Performance/master.adoc index 54c0e265179..3fe7ba377a3 100644 --- a/guides/doc-Tuning_Performance/master.adoc +++ b/guides/doc-Tuning_Performance/master.adoc @@ -22,7 +22,7 @@ endif::[] include::common/modules/ref_system-requirements-for-tuning.adoc[leveloffset=+1] -include::common/modules/proc_determining-hardware-and-os-configuration.adoc[leveloffset=+1] +include::common/modules/proc_determining-hardware-and-operating-system-configuration.adoc[leveloffset=+1] include::common/modules/proc_benchmark-disk-performance.adoc[leveloffset=+2]