Skip to content

Remove more IDs from anchors in Provisioning guide #5050

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
maximiliankolb wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Remove more IDs from anchors in Provisioning guide #5050

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion guides/common/assembly_bootloader-binary-location.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ include::modules/ref_boot-loader-types-in-project.adoc[leveloffset=+1]

include::modules/ref_pxelinux-boot-loaders.adoc[leveloffset=+1]

include::modules/ref_grub2-uefi-boot-loaders.adoc[leveloffset=+1]
include::modules/ref_grub2-uefi-boot-loader-and-the-bootloader-universe-structure.adoc[leveloffset=+1]

include::modules/ref_http-capable-boot-loaders.adoc[leveloffset=+1]
4 changes: 2 additions & 2 deletions guides/common/assembly_building-cloud-images-for-project.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ include::modules/con_building-cloud-images-for-project.adoc[]

include::modules/ref_preconfigured-rhel-kvm-guest-images.adoc[leveloffset=+1]

include::modules/ref_host-requirements-for-custom-images.adoc[leveloffset=+1]
include::modules/ref_host-requirements-for-custom-rhel-images.adoc[leveloffset=+1]

include::modules/ref_supported-clients-in-registration.adoc[leveloffset=+1]

Expand All @@ -19,5 +19,5 @@ include::modules/proc_registering-a-host-by-using-ansible.adoc[leveloffset=+1]
include::modules/proc_configuring-openvox-agent-on-a-host-manually.adoc[leveloffset=+1]

ifdef::satellite[]
include::modules/proc_completing-the-rhel7-image.adoc[leveloffset=+1]
include::modules/proc_completing-the-rhel-7-image.adoc[leveloffset=+1]
endif::[]
4 changes: 2 additions & 2 deletions guides/common/assembly_discovering-hosts-on-a-network.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ include::modules/proc_installing-the-discovery-service.adoc[leveloffset=+1]
// PXE Discovery
include::modules/con_discovery-in-pxe-mode.adoc[leveloffset=+1]

include::modules/proc_setting-discovery-as-the-default-PXE-boot-option.adoc[leveloffset=+2]
include::modules/proc_setting-discovery-as-the-default-pxe-boot-option.adoc[leveloffset=+2]

include::modules/proc_performing-discovery-in-pxe-mode.adoc[leveloffset=+2]

Expand All @@ -20,7 +20,7 @@ endif::[]
// PXE-less Discovery
include::modules/con_discovery-in-pxeless-mode.adoc[leveloffset=+1]

include::modules/proc_performing-discovery-in-pxeless-mode.adoc[leveloffset=+2]
include::modules/proc_performing-discovery-in-pxe-less-mode.adoc[leveloffset=+2]

include::modules/proc_customizing-the-discovery-iso.adoc[leveloffset=+2]

Expand Down
2 changes: 1 addition & 1 deletion guides/common/assembly_using-boot-disks-to-provision-hosts.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ include::modules/con_boot-disk-workflow.adoc[leveloffset=+1]
include::modules/con_boot-disk-types.adoc[leveloffset=+1]

ifndef::satellite[]
include::modules/proc_enabling-bootdisk-plugin.adoc[leveloffset=+1]
include::modules/proc_enabling-the-bootdisk-plugin.adoc[leveloffset=+1]
endif::[]

include::modules/proc_generating-a-full-host-boot-disk-by-using-web-ui.adoc[leveloffset=+1]
Expand Down
16 changes: 8 additions & 8 deletions guides/common/assembly_using-network-boot-to-provision-hosts.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ include::modules/ref_required-boot-order-for-network-boot.adoc[leveloffset=+1]
:parent-client-pkg-ext: {client-pkg-ext}

ifdef::foreman-el,foreman-deb,katello,almalinux,debian,red_hat_enterprise_linux,rocky_linux,ubuntu[]
include::modules/con_configuring-smartproxy-for-secure-boot.adoc[leveloffset=+1]
include::modules/con_configuring-smart-proxy-for-secure-boot.adoc[leveloffset=+1]
endif::[]

ifdef::foreman-el,foreman-deb,katello,almalinux[]
Expand All @@ -37,7 +37,7 @@ ifdef::foreman-el,foreman-deb,katello,almalinux[]
:shim_efi_tmp_binary_path: /tmp/boot/efi/EFI/{client-os-context}/shimx64.efi
:extract_grub: {extract_rpm_prefix}/{grub_efi_downloaded_package_name} {extract_rpm_suffix}
:extract_shim: {extract_rpm_prefix}/{shim_efi_downloaded_package_name} {extract_rpm_suffix}
include::modules/proc_configuring-smart-proxy-to-provision-secure-boot-enabled-hosts.adoc[leveloffset=+2]
include::modules/proc_configuring-smart-proxy-to-provision-client-os-on-secure-boot-enabled-hosts.adoc[leveloffset=+2]
endif::[]

ifdef::foreman-el,foreman-deb,katello,debian[]
Expand All @@ -55,7 +55,7 @@ ifdef::foreman-el,foreman-deb,katello,debian[]
:shim_efi_tmp_binary_path: /tmp/usr/lib/shim/shimx64.efi.signed
:extract_grub: {extract_deb_prefix}/{grub_efi_downloaded_package_name} {extract_deb_xz_suffix}
:extract_shim: {extract_deb_prefix}/{shim_efi_downloaded_package_name} {extract_deb_xz_suffix}
include::modules/proc_configuring-smart-proxy-to-provision-secure-boot-enabled-hosts.adoc[leveloffset=+2]
include::modules/proc_configuring-smart-proxy-to-provision-client-os-on-secure-boot-enabled-hosts.adoc[leveloffset=+2]
endif::[]

ifdef::foreman-el,foreman-deb,katello,satellite,red_hat_enterprise_linux[]
Expand All @@ -75,10 +75,10 @@ ifdef::foreman-el,foreman-deb,katello,satellite,red_hat_enterprise_linux[]
:extract_shim: {extract_rpm_prefix}/{shim_efi_downloaded_package_name} {extract_rpm_suffix}
endif::[]
ifdef::foreman-el,foreman-deb,katello,red_hat_enterprise_linux[]
include::modules/proc_configuring-smart-proxy-to-provision-secure-boot-enabled-hosts.adoc[leveloffset=+2]
include::modules/proc_configuring-smart-proxy-to-provision-client-os-on-secure-boot-enabled-hosts.adoc[leveloffset=+2]
endif::[]
ifdef::satellite[]
include::modules/proc_configuring-smart-proxy-to-provision-secure-boot-enabled-hosts.adoc[leveloffset=+1]
include::modules/proc_configuring-smart-proxy-to-provision-client-os-on-secure-boot-enabled-hosts.adoc[leveloffset=+1]
endif::[]

ifdef::foreman-el,foreman-deb,katello,rocky_linux[]
Expand All @@ -96,7 +96,7 @@ ifdef::foreman-el,foreman-deb,katello,rocky_linux[]
:shim_efi_tmp_binary_path: /tmp/boot/efi/EFI/{client-os-context}/shimx64.efi
:extract_grub: {extract_rpm_prefix}/{grub_efi_downloaded_package_name} {extract_rpm_suffix}
:extract_shim: {extract_rpm_prefix}/{shim_efi_downloaded_package_name} {extract_rpm_suffix}
include::modules/proc_configuring-smart-proxy-to-provision-secure-boot-enabled-hosts.adoc[leveloffset=+2]
include::modules/proc_configuring-smart-proxy-to-provision-client-os-on-secure-boot-enabled-hosts.adoc[leveloffset=+2]
endif::[]

ifdef::foreman-el,foreman-deb,katello,ubuntu[]
Expand All @@ -114,7 +114,7 @@ ifdef::foreman-el,foreman-deb,katello,ubuntu[]
:shim_efi_tmp_binary_path: /tmp/usr/lib/shim/shimx64.efi.signed.latest
:extract_grub: {extract_deb_prefix}/{grub_efi_downloaded_package_name} {extract_deb_zst_suffix}
:extract_shim: {extract_deb_prefix}/{shim_efi_downloaded_package_name} {extract_deb_xz_suffix}
include::modules/proc_configuring-smart-proxy-to-provision-secure-boot-enabled-hosts.adoc[leveloffset=+2]
include::modules/proc_configuring-smart-proxy-to-provision-client-os-on-secure-boot-enabled-hosts.adoc[leveloffset=+2]
endif::[]

// reset global attributes
Expand Down Expand Up @@ -144,7 +144,7 @@ include::modules/proc_creating-hosts-with-pxe-boot-provisioning-by-using-web-ui.

include::modules/proc_creating-hosts-with-pxe-boot-provisioning-by-using-cli.adoc[leveloffset=+1]

include::modules/proc_configuring-smartproxy-for-uefi-http-booting.adoc[leveloffset=+1]
include::modules/proc_configuring-smart-proxy-for-uefi-http-booting.adoc[leveloffset=+1]

include::modules/proc_creating-hosts-with-uefi-http-boot-provisioning-by-using-web-ui.adoc[leveloffset=+1]

Expand Down
2 changes: 1 addition & 1 deletion guides/common/modules/con_configuring-provisioning.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
ifndef::satellite[]
+
This requires the Discovery plugin.
For more information, see {ProvisioningDocURL}Installing_the_Discovery_Service_provisioning[Installing the Discovery service] in _{ProvisioningDocTitle}_.
For more information, see {ProvisioningDocURL}installing-the-discovery-service[Installing the Discovery service] in _{ProvisioningDocTitle}_.

Check failure on line 19 in guides/common/modules/con_configuring-provisioning.adoc

View workflow job for this annotation

GitHub Actions / lint style 

[vale] reported by reviewdog 🐶
[foreman-documentation.Capitalization] Use 'Discovery' instead of 'discovery' unless you are using the term in a context that requires different capitalization. For example, different capitalization might be required in Web UI buttons, settings, or templates.

Raw Output:
{"message": "[foreman-documentation.Capitalization] Use 'Discovery' instead of 'discovery' unless you are using the term in a context that requires different capitalization. For example, different capitalization might be required in Web UI buttons, settings, or templates.", "location": {"path": "guides/common/modules/con_configuring-provisioning.adoc", "range": {"start": {"line": 19, "column": 62}}}, "severity": "ERROR"}
endif::[]
* Host groups enable you to standardize provisioning of host configurations.

Expand Down
0 ...nfiguring-smartproxy-for-secure-boot.adoc → ...figuring-smart-proxy-for-secure-boot.adoc
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion guides/common/modules/con_prerequisites-for-using-discovery.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
:_mod-docs-content-type: CONCEPT

[id="prerequisites-for-using-discovery_{context}"]
[id="prerequisites-for-using-discovery"]
= Prerequisites for using Discovery

[role="_abstract"]
Expand Down
2 changes: 1 addition & 1 deletion guides/common/modules/con_using-ipxe-to-reduce-provisioning-times.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
:_mod-docs-content-type: CONCEPT

[id="using-ipxe-to-reduce-provisioning-times_{context}"]
[id="using-ipxe-to-reduce-provisioning-times"]
= Using iPXE to reduce provisioning times

[role="_abstract"]
Expand Down
4 changes: 2 additions & 2 deletions guides/common/modules/proc_booting-virtual-machines.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="Booting_Virtual_Machines_{context}"]
[id="booting-virtual-machines"]
= Booting virtual machines

[role="_abstract"]
Expand All @@ -16,10 +16,10 @@
** VMWare (https://ipxe.org/howto/vmware[via custom firmware])
endif::[]
* You have configured your iPXE environment.
For more information, see xref:Configuring_iPXE_Environment_{context}[].
For more information, see xref:configuring-ipxe-environment[].

.Procedure
. In the {ProjectWebUI}, navigate to *Hosts* > *Templates* > *Provisioning Templates*.

Check failure on line 22 in guides/common/modules/proc_booting-virtual-machines.adoc

View workflow job for this annotation

GitHub Actions / lint style 

[vale] reported by reviewdog 🐶
[foreman-documentation.ProcedureStepLimit] Procedure contains more than 10 steps. Split it into multiple procedures or leverage substeps to group related steps. If the procedure contains conditionals, review the preview to ensure all built targets comply with the limit of 10 steps.

Raw Output:
{"message": "[foreman-documentation.ProcedureStepLimit] Procedure contains more than 10 steps. Split it into multiple procedures or leverage substeps to group related steps. If the procedure contains conditionals, review the preview to ensure all built targets comply with the limit of 10 steps.", "location": {"path": "guides/common/modules/proc_booting-virtual-machines.adoc", "range": {"start": {"line": 22, "column": 1}}}, "severity": "ERROR"}
ifdef::foreman-el,foreman-deb,katello[]
. Search for the required template:
* For Debian hosts, select the `Preseed default iPXE` template.
Expand Down
4 changes: 2 additions & 2 deletions guides/common/modules/proc_building-a-custom-discovery-image.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="Building_a_custom_Discovery_Image_{context}"]
[id="building-a-custom-discovery-image"]
= Building a custom Discovery image

[role="_abstract"]
Expand Down Expand Up @@ -74,7 +74,7 @@ fdi.pxdns=192.168.140.2 proxy.url=https://{foreman-example-com}:8443 \
proxy.type=foreman fdi.pxmac=52:54:00:be:8e:8c fdi.pxauto=1"
----
+
For more information about configuration options, see xref:kernel-parameters-for-discovery-customization_{context}[].
For more information about configuration options, see xref:kernel-parameters-for-discovery-customization[].
. Verify that your `./result/fdi-custom-XXXXXXX.iso` file is created:
+
[options="nowrap" subs="+quotes"]
Expand Down
4 changes: 2 additions & 2 deletions guides/common/modules/proc_chainbooting-ipxe-from-pxelinux.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="Chainbooting_iPXE_from_PXELinux_{context}"]
[id="chainbooting-ipxe-from-pxelinux"]
= Chainbooting iPXE from PXELinux

[role="_abstract"]
Expand All @@ -13,10 +13,10 @@

.Prerequisites
* You have configured your iPXE environment.
For more information, see xref:Configuring_iPXE_Environment_{context}[].
For more information, see xref:configuring-ipxe-environment[].

.Procedure
. In the {ProjectWebUI}, navigate to *Hosts* > *Templates* > *Provisioning Templates*.

Check failure on line 19 in guides/common/modules/proc_chainbooting-ipxe-from-pxelinux.adoc

View workflow job for this annotation

GitHub Actions / lint style 

[vale] reported by reviewdog 🐶
[foreman-documentation.ProcedureStepLimit] Procedure contains more than 10 steps. Split it into multiple procedures or leverage substeps to group related steps. If the procedure contains conditionals, review the preview to ensure all built targets comply with the limit of 10 steps.

Raw Output:
{"message": "[foreman-documentation.ProcedureStepLimit] Procedure contains more than 10 steps. Split it into multiple procedures or leverage substeps to group related steps. If the procedure contains conditionals, review the preview to ensure all built targets comply with the limit of 10 steps.", "location": {"path": "guides/common/modules/proc_chainbooting-ipxe-from-pxelinux.adoc", "range": {"start": {"line": 19, "column": 1}}}, "severity": "ERROR"}
. Search for the required PXELinux template:
* `PXELinux chain iPXE` to use `ipxe.lkrn`
* `PXELinux chain iPXE UNDI` to use `undionly-ipxe.0`
Expand Down
46 changes: 23 additions & 23 deletions ...ules/proc_completing-the-rhel7-image.adoc → ...les/proc_completing-the-rhel-7-image.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,72 +1,72 @@
:_mod-docs-content-type: PROCEDURE

[id="Completing_the_RHEL7_Image_{context}"]
[id="completing-the-rhel-7-image"]
= Completing the {RHEL} 7 image

[role="_abstract"]
To ensure that VMs deployed from your image are treated as clean and unique instances that can be successfully registered and managed by {Project}, prepare your pre-built {RHEL} 7 image for cloud or virtual machine deployment and subsequent management by {Project}.

.Procedure
. Update the system:

Check failure on line 10 in guides/common/modules/proc_completing-the-rhel-7-image.adoc

View workflow job for this annotation

GitHub Actions / lint style 

[vale] reported by reviewdog 🐶
[foreman-documentation.ProcedureStepLimit] Procedure contains more than 10 steps. Split it into multiple procedures or leverage substeps to group related steps. If the procedure contains conditionals, review the preview to ensure all built targets comply with the limit of 10 steps.

Raw Output:
{"message": "[foreman-documentation.ProcedureStepLimit] Procedure contains more than 10 steps. Split it into multiple procedures or leverage substeps to group related steps. If the procedure contains conditionals, review the preview to ensure all built targets comply with the limit of 10 steps.", "location": {"path": "guides/common/modules/proc_completing-the-rhel-7-image.adoc", "range": {"start": {"line": 10, "column": 1}}}, "severity": "ERROR"}
+
-----------
----
# yum update
-----------
----
. Install the `cloud-init` packages:

Check failure on line 15 in guides/common/modules/proc_completing-the-rhel-7-image.adoc

View workflow job for this annotation

GitHub Actions / lint style 

[vale] reported by reviewdog 🐶
[foreman-documentation.ProcedureStepLimit] Procedure contains more than 10 steps. Split it into multiple procedures or leverage substeps to group related steps. If the procedure contains conditionals, review the preview to ensure all built targets comply with the limit of 10 steps.

Raw Output:
{"message": "[foreman-documentation.ProcedureStepLimit] Procedure contains more than 10 steps. Split it into multiple procedures or leverage substeps to group related steps. If the procedure contains conditionals, review the preview to ensure all built targets comply with the limit of 10 steps.", "location": {"path": "guides/common/modules/proc_completing-the-rhel-7-image.adoc", "range": {"start": {"line": 15, "column": 1}}}, "severity": "ERROR"}
+
[options="nowrap" subs="+quotes,attributes"]
-----------
----
# yum install cloud-utils-growpart cloud-init
-----------
----
. Open the `/etc/cloud/cloud.cfg` configuration file:

Check failure on line 21 in guides/common/modules/proc_completing-the-rhel-7-image.adoc

View workflow job for this annotation

GitHub Actions / lint style 

[vale] reported by reviewdog 🐶
[foreman-documentation.ProcedureStepLimit] Procedure contains more than 10 steps. Split it into multiple procedures or leverage substeps to group related steps. If the procedure contains conditionals, review the preview to ensure all built targets comply with the limit of 10 steps.

Raw Output:
{"message": "[foreman-documentation.ProcedureStepLimit] Procedure contains more than 10 steps. Split it into multiple procedures or leverage substeps to group related steps. If the procedure contains conditionals, review the preview to ensure all built targets comply with the limit of 10 steps.", "location": {"path": "guides/common/modules/proc_completing-the-rhel-7-image.adoc", "range": {"start": {"line": 21, "column": 1}}}, "severity": "ERROR"}
+
-----------
----
# vi /etc/cloud/cloud.cfg
-----------
----
. Under the heading `cloud_init_modules`, add:

Check failure on line 26 in guides/common/modules/proc_completing-the-rhel-7-image.adoc

View workflow job for this annotation

GitHub Actions / lint style 

[vale] reported by reviewdog 🐶
[foreman-documentation.ProcedureStepLimit] Procedure contains more than 10 steps. Split it into multiple procedures or leverage substeps to group related steps. If the procedure contains conditionals, review the preview to ensure all built targets comply with the limit of 10 steps.

Raw Output:
{"message": "[foreman-documentation.ProcedureStepLimit] Procedure contains more than 10 steps. Split it into multiple procedures or leverage substeps to group related steps. If the procedure contains conditionals, review the preview to ensure all built targets comply with the limit of 10 steps.", "location": {"path": "guides/common/modules/proc_completing-the-rhel-7-image.adoc", "range": {"start": {"line": 26, "column": 1}}}, "severity": "ERROR"}
+
-----------
----
- resolv-conf
-----------
----
+
The `resolv-conf` option automatically configures the `resolv.conf` when an instance boots for the first time.
This file contains information related to the instance such as `nameservers`, `domain` and other options.
. Open the `/etc/sysconfig/network` file:

Check failure on line 34 in guides/common/modules/proc_completing-the-rhel-7-image.adoc

View workflow job for this annotation

GitHub Actions / lint style 

[vale] reported by reviewdog 🐶
[foreman-documentation.ProcedureStepLimit] Procedure contains more than 10 steps. Split it into multiple procedures or leverage substeps to group related steps. If the procedure contains conditionals, review the preview to ensure all built targets comply with the limit of 10 steps.

Raw Output:
{"message": "[foreman-documentation.ProcedureStepLimit] Procedure contains more than 10 steps. Split it into multiple procedures or leverage substeps to group related steps. If the procedure contains conditionals, review the preview to ensure all built targets comply with the limit of 10 steps.", "location": {"path": "guides/common/modules/proc_completing-the-rhel-7-image.adoc", "range": {"start": {"line": 34, "column": 1}}}, "severity": "ERROR"}
+
-----------
----
# vi /etc/sysconfig/network
-----------
----
. Add the following line to avoid problems accessing the EC2 metadata service:

Check failure on line 39 in guides/common/modules/proc_completing-the-rhel-7-image.adoc

View workflow job for this annotation

GitHub Actions / lint style 

[vale] reported by reviewdog 🐶
[foreman-documentation.ProcedureStepLimit] Procedure contains more than 10 steps. Split it into multiple procedures or leverage substeps to group related steps. If the procedure contains conditionals, review the preview to ensure all built targets comply with the limit of 10 steps.

Raw Output:
{"message": "[foreman-documentation.ProcedureStepLimit] Procedure contains more than 10 steps. Split it into multiple procedures or leverage substeps to group related steps. If the procedure contains conditionals, review the preview to ensure all built targets comply with the limit of 10 steps.", "location": {"path": "guides/common/modules/proc_completing-the-rhel-7-image.adoc", "range": {"start": {"line": 39, "column": 1}}}, "severity": "ERROR"}
+
-----------
----
NOZEROCONF=yes
-----------
----
. Un-register the virtual machine so that the resulting image does not contain the same subscription details for every instance cloned based on it:
+
------------
----
# subscription-manager repos --disable=*
# subscription-manager unregister
------------
----
. Power off the instance:
+
-----------
----
# poweroff
-----------
----
. On your {RHEL} Workstation, connect to the terminal as the root user and navigate to the `/var/lib/libvirt/images/` directory:
+
-----------
----
# cd /var/lib/libvirt/images/
-----------
----
. Reset and clean the image using the `virt-sysprep` command so it can be used to create instances without issues:
+
-----------
----
# virt-sysprep -d rhel7
-----------
----
. Reduce image size using the `virt-sparsify` command.
This command converts any free space within the disk image back to free space within the host:
+
-----------
----
# virt-sparsify --compress rhel7.qcow2 rhel7-cloud.qcow2
-----------
----
+
This creates a new `rhel7-cloud.qcow2` file in the location where you enter the command.
4 changes: 2 additions & 2 deletions guides/common/modules/proc_configuring-a-host-for-registration.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="Configuring_a_Host_for_Registration_{context}"]
[id="configuring-a-host-for-registration"]
= Configuring a host for registration

[role="_abstract"]
Expand All @@ -9,7 +9,7 @@ You can use a configuration management tool to configure multiple hosts at once.

.Prerequisites
* The host must be using a supported operating system.
For more information, see xref:supported-clients-in-registration_{context}[].
For more information, see xref:supported-clients-in-registration[].
ifdef::satellite,orcharhino,katello[]
* The system clock on your {ProjectServer} and any {SmartProxyServers} must be synchronized across the network.
If the system clock is not synchronized, SSL certificate verification might fail.
Expand Down
2 changes: 1 addition & 1 deletion guides/common/modules/proc_configuring-ipxe-environment.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="Configuring_iPXE_Environment_{context}"]
[id="configuring-ipxe-environment"]
= Configuring iPXE environment

[role="_abstract"]
Expand Down
0 ...ing-smartproxy-for-uefi-http-booting.adoc → ...ng-smart-proxy-for-uefi-http-booting.adoc
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion ...-provision-secure-boot-enabled-hosts.adoc → ...ient-os-on-secure-boot-enabled-hosts.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="configuring-{smart-proxy-context}-to-provision-{client-os-context}-on-Secure-Boot-enabled-hosts"]
[id="configuring-{smart-proxy-context}-to-provision-{client-os-context}-on-secure-boot-enabled-hosts"]

Check warning on line 3 in guides/common/modules/proc_configuring-smart-proxy-to-provision-client-os-on-secure-boot-enabled-hosts.adoc

View workflow job for this annotation

GitHub Actions / Filename-ID-Heading match 

[Filename-ID-heading-match] reported by reviewdog 🐶
ID 'configuring-{smart-proxy-context}-to-provision-{client-os-context}-on-secure-boot-enabled-hosts' does not match expected 'configuring-smart-proxy-to-provision-client-os-on-secure-boot-enabled-hosts' | Heading 'Configuring {SmartProxy} to provision {client-os} on Secure Boot enabled hosts' does not match ID

Raw Output:
{"message":"ID 'configuring-{smart-proxy-context}-to-provision-{client-os-context}-on-secure-boot-enabled-hosts' does not match expected 'configuring-smart-proxy-to-provision-client-os-on-secure-boot-enabled-hosts' | Heading 'Configuring {SmartProxy} to provision {client-os} on Secure Boot enabled hosts' does not match ID","location":{"path":"guides/common/modules/proc_configuring-smart-proxy-to-provision-client-os-on-secure-boot-enabled-hosts.adoc","range":{"start":{"line":3}}},"severity":"WARNING"}

@aneta-petrova aneta-petrova Jul 17, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would you consider looking into this Vale error so we keep the filename-ID-heading-match checker up-to-date? Looking at it briefly, it should be just the normalization for {client-os-context} that's missing to make the check mass.

= Configuring {SmartProxy} to provision {client-os} on Secure Boot enabled hosts

[role="_abstract"]
Expand Down
4 changes: 2 additions & 2 deletions guides/common/modules/proc_customizing-the-discovery-iso.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="customizing-the-discovery-iso_{context}"]
[id="customizing-the-discovery-iso"]
= Customizing the Discovery ISO

[role="_abstract"]
Expand Down Expand Up @@ -33,7 +33,7 @@ fdi.pxfactvalue1=_My_Host_ \
fdi.pxmac=52:54:00:be:8e:8c fdi.pxauto=1"
----
+
For more information about kernel parameters, see xref:kernel-parameters-for-discovery-customization_{context}[].
For more information about kernel parameters, see xref:kernel-parameters-for-discovery-customization[].
. Copy the new ISO to either a CD, DVD, or a USB stick.
For example, to copy to a USB stick at `/dev/sdb`:
+
Expand Down
4 changes: 2 additions & 2 deletions guides/common/modules/proc_customizing-the-discovery-pxe-boot.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="Customizing_the_Discovery_PXE_Boot_{context}"]
[id="customizing-the-discovery-pxe-boot"]
= Customizing the Discovery PXE boot

[role="_abstract"]
Expand Down Expand Up @@ -28,7 +28,7 @@ The `APPEND` option contains kernel parameters.
This snippet renders the Discovery GRUB2 menu entry.
The `common` variable contains kernel parameters.

For information about the kernel parameters, see xref:kernel-parameters-for-discovery-customization_{context}[].
For information about the kernel parameters, see xref:kernel-parameters-for-discovery-customization[].

.Procedure
. In the {ProjectWebUI}, navigate to *Hosts* > *Templates* > *Provisioning Templates*.
Expand Down
4 changes: 2 additions & 2 deletions ...odules/proc_enabling-bootdisk-plugin.adoc → ...es/proc_enabling-the-bootdisk-plugin.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:_mod-docs-content-type: PROCEDURE

[id="enabling-bootdisk-plugin"]
= Enabling Bootdisk plugin
[id="enabling-the-bootdisk-plugin"]
= Enabling the Bootdisk plugin

[role="_abstract"]
Enable the Bootdisk plugin to perform boot disk-based host provisioning.
Expand Down
4 changes: 2 additions & 2 deletions guides/common/modules/proc_extending-the-discovery-image.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="Extending_the_Discovery_Image_{context}"]
[id="extending-the-discovery-image"]
= Extending the Discovery image

[role="_abstract"]
Expand Down Expand Up @@ -45,7 +45,7 @@ For example, if you have two archives at `$TFTP/zip1.zip` and `$TFTP/boot/zip2.z
fdi.zips=zip1.zip,boot/zip2.zip
----
+
For more information, see xref:Customizing_the_Discovery_PXE_Boot_{context}[].
For more information, see xref:customizing-the-discovery-pxe-boot[].
+
You can append new directives and options to the existing environment variables (`PATH`, `LD_LIBRARY_PATH`, `RUBYLIB` and `FACTERLIB`).
If you want to specify the path explicitly in your scripts, the `.zip` file contents are extracted to the `/opt/extension` directory on the image.
Expand Down
2 changes: 1 addition & 1 deletion guides/common/modules/proc_installing-the-discovery-service.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
:_mod-docs-content-type: PROCEDURE

[id="Installing_the_Discovery_Service_{context}"]
[id="installing-the-discovery-service"]
= Installing the Discovery service

[role="_abstract"]
Expand Down
Loading
Loading