Skip to content

Commit 60f32b2

Browse files
webadmin: remove asciidoctor errors and html syntax issues
* removed rest-api docs due to it now being hosted on it's own github pages * updated google maps links to generate valid html syntax * updated links to be relative instead of absolute * downgraded leveloffset on certain files to disable too deep of an offset * fixed generation of footnotes in code blocks Signed-off-by: Jasper Berton <jasper.berton@team.blue>
1 parent ea4a991 commit 60f32b2

25 files changed

+40
-58660
lines changed

source/_includes/events_index.haml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@
7272
.conference-info
7373
- if conf.location
7474
%h3.location
75-
%a{:href => "https://maps.google.com/maps?q=" + conf.location, :target => "_blank"}
75+
%a{:href => "https://maps.google.com/maps?q=" + URI.encode_www_form_component(conf.location), :target => "_blank"}
7676
= conf.location
7777

7878
- if conf.start
@@ -105,10 +105,10 @@
105105

106106
- if talk.location
107107
%h4.location
108-
%a{:href => "https://maps.google.com/maps?q=" + talk.location, :target => "_blank"}
108+
%a{:href => "https://maps.google.com/maps?q=" + URI.encode_www_form_component(conf.location), :target => "_blank"}
109109
- elsif conf.location
110110
%h4.location.hidden
111-
%a{:href => "https://maps.google.com/maps?q=" + conf.location, :target => "_blank"}
111+
%a{:href => "https://maps.google.com/maps?q=" + URI.encode_www_form_component(conf.location), :target => "_blank"}
112112

113113
%h4.speaker= talk.speaker
114114

source/documentation/administration_guide/appe-enabling_FIPS.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ include::topics/proc-enabling-fips_she.adoc[leveloffset=+1]
4141

4242
include::topics/proc-enabling-fips_rhel_hosts_and_rhvm.adoc[leveloffset=+1]
4343

44-
== Additional resources
44+
.Additional resources
4545

4646
* link:{URL_downstream_virt_product_docs}installing_red_hat_virtualization_as_a_self-hosted_engine_using_the_command_line/index#Installing_Red_Hat_Virtualization_Hosts_SHE_cli_deploy[Installing {virt-product-fullname} Hosts]
4747
* link:https://www.redhat.com/en/blog/configuring-and-applying-scap-policies-during-installation[Configuring and Applying SCAP Policies During Installation]

source/documentation/administration_guide/topics/Updating_a_host_between_minor_releases.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@
77

88
You can update xref:Updating_all_hosts_in_a_cluster_admin[all hosts in a cluster], or update xref:Updating_Individual_Hosts_admin[individual hosts].
99

10-
include::../common/upgrade/proc-Updating_all_hosts_in_a_cluster.adoc[leveloffset=+1]
10+
include::../common/upgrade/proc-Updating_all_hosts_in_a_cluster.adoc[leveloffset=+0]
1111

12-
include::../common/upgrade/proc-Updating_Individual_Hosts.adoc[leveloffset=+1]
12+
include::../common/upgrade/proc-Updating_Individual_Hosts.adoc[leveloffset=+0]
1313

1414
[NOTE]
1515
====
1616
You should update the hosts from the Administration Portal. However, you can update the hosts using `dnf upgrade` instead.
1717
====
1818

19-
include::../common/upgrade/proc-Manually_Updating_Hosts.adoc[leveloffset=+1]
19+
include::../common/upgrade/proc-Manually_Updating_Hosts.adoc[leveloffset=+0]
2020

2121
:admin_minor_updates!:

source/documentation/common/install/con-Recommended_practices_for_configuring_host_networks.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22
[id="Recommended_practices_for_configuring_host_networks_{context}"]
33
= Recommended Practices for Configuring Host Networks
44

5-
IMPORTANT: Always use the {virt-product-shortname} {engine-name} to modify the network configuration of hosts in your clusters. Otherwise, you might create an unsupported configuration. For details, see link:{URL_virt_product_docs}{URL_format}administration_guide/index#con-Network-Manager-Stateful-Configuration-nmstate[Network Manager Stateful Configuration (nmstate)].
5+
IMPORTANT: Always use the {virt-product-shortname} {engine-name} to modify the network configuration of hosts in your clusters. Otherwise, you might create an unsupported configuration. For details, see link:/documentation/administration_guide/index.html#con-Network-Manager-Stateful-Configuration-nmstate[Network Manager Stateful Configuration (nmstate)].
66

77
If your network environment is complex, you may need to configure a host network manually before adding the host to the {virt-product-fullname} {engine-name}.
88

99
Consider the following practices for configuring a host network:
1010

1111
* Configure the network with Cockpit. Alternatively, you can use `nmtui` or `nmcli`.
1212
13-
* If a network is not required for a self-hosted engine deployment or for adding a host to the {engine-name}, configure the network in the Administration Portal after adding the host to the {engine-name}. See link:{URL_virt_product_docs}{URL_format}administration_guide/index#Creating_a_new_logical_network_in_a_data_center_or_cluster[Creating a New Logical Network in a Data Center or Cluster].
13+
* If a network is not required for a self-hosted engine deployment or for adding a host to the {engine-name}, configure the network in the Administration Portal after adding the host to the {engine-name}. See link:/documentation/administration_guide/index.html#Creating_a_new_logical_network_in_a_data_center_or_cluster[Creating a New Logical Network in a Data Center or Cluster].
1414
1515
* Use the following naming conventions:
1616
@@ -19,13 +19,13 @@ Consider the following practices for configuring a host network:
1919
** Bond interfaces: `bond__number__` (for example, `bond0`, `bond1`)
2020
** VLANs on bond interfaces: `bond__number__.__VLAN_ID__` (for example, `bond0.50`, `bond1.128`)
2121

22-
* Use link:{URL_virt_product_docs}{URL_format}administration_guide/index#sect-Network_Bonding[network bonding]. Network teaming is not supported in {virt-product-fullname} and will cause errors if the host is used to deploy a self-hosted engine or added to the {engine-name}.
22+
* Use link:/documentation/administration_guide/index#sect-Network_Bonding[network bonding]. Network teaming is not supported in {virt-product-fullname} and will cause errors if the host is used to deploy a self-hosted engine or added to the {engine-name}.
2323
2424
* Use recommended bonding modes:
2525
2626
** If the `ovirtmgmt` network is not used by virtual machines, the network may use any supported bonding mode.
2727
** If the `ovirtmgmt` network is used by virtual machines, see link:https://access.redhat.com/solutions/67546[_Which bonding modes work when used with a bridge that virtual machine guests or containers connect to?_].
28-
** {virt-product-fullname}'s default bonding mode is `(Mode 4) Dynamic Link Aggregation`. If your switch does not support Link Aggregation Control Protocol (LACP), use `(Mode 1) Active-Backup`. See link:{URL_virt_product_docs}{URL_format}administration_guide/index#Bonding_Modes[Bonding Modes] for details.
28+
** {virt-product-fullname}'s default bonding mode is `(Mode 4) Dynamic Link Aggregation`. If your switch does not support Link Aggregation Control Protocol (LACP), use `(Mode 1) Active-Backup`. See link:/documentation/administration_guide/index.html#Bonding_Modes[Bonding Modes] for details.
2929
3030
* Configure a VLAN on a physical NIC as in the following example (although `nmcli` is used, you can use any tool):
3131
+
@@ -48,4 +48,4 @@ Consider the following practices for configuring a host network:
4848
4949
* Do not disable `firewalld`.
5050
51-
* Customize the firewall rules in the Administration Portal after adding the host to the {engine-name}. See link:{URL_virt_product_docs}{URL_format}administration_guide/index#Configuring_Host_Firewall_Rules[Configuring Host Firewall Rules].
51+
* Customize the firewall rules in the Administration Portal after adding the host to the {engine-name}. See link:/documentation/administration_guide/index.html#Configuring_Host_Firewall_Rules[Configuring Host Firewall Rules].

source/documentation/common/install/proc-customizing_engine_vm_during_deployment_auto.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,5 +34,5 @@ When you run the self-hosted-engine installer, the deployment script runs the `o
3434
.Additional resources
3535

3636
* link:{URL_downstream_virt_product_docs}installing_red_hat_virtualization_as_a_self-hosted_engine_using_the_command_line/index#Deploying_the_Self-Hosted_Engine_Using_the_CLI_install_RHVM[Deploying the self-hosted engine using the command line]
37-
* link:{URL_virt_product_docs}{URL_format}administration_guide/index#chap-Automating_RHV_Configuration_using_Ansible[Automating Configuration Tasks using Ansible]
37+
* link:/documentation/administration_guide/index#chap-Automating_RHV_Configuration_using_Ansible[Automating Configuration Tasks using Ansible]
3838
* link:https://docs.ansible.com/ansible/latest/user_guide/playbooks_intro.html[Intro to playbooks] in the Ansible documentation

source/documentation/common/sriov/assembly-Set_Up_and_Configure_SR-IOV.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ The following example shows you how to get diagnostic information about the VFs
7171

7272
// include::conc-What-are-SR-IOV-and-ARI.adoc[leveloffset=+1]
7373

74-
== Additional Resources
74+
.Additional Resources
7575

7676
* link:https://access.redhat.com/solutions/3867761[How to configure SR-IOV passthrough for RHV VM?]
7777
* link:https://access.redhat.com/articles/3215851[How to configure bonding with SR-IOV VF(Virtual Function) in RHV]

source/documentation/common/upgrade/proc-Replacing_SHA-1_Certificates_with_SHA-256_Certificates.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ ifdef::SHE_upgrade[]
4747
endif::SHE_upgrade[]
4848
. On the {engine-name}, save a backup of the `/etc/ovirt-engine/engine.conf.d` and `/etc/pki/ovirt-engine` directories, and re-sign the certificates:
4949
+
50-
[source,terminal,subs="normal"]
50+
[source,terminal]
5151
----
5252
# . /etc/ovirt-engine/engine.conf.d/10-setup-protocols.conf
5353
# for name in $names; do
@@ -63,13 +63,13 @@ endif::SHE_upgrade[]
6363
)"
6464
/usr/share/ovirt-engine/bin/pki-enroll-pkcs12.sh \
6565
--name="${name}" \
66-
--password=mypass \ <1>
66+
--password=mypass \ <!--1-->
6767
--subject="${subject}" \
6868
--san=DNS:"${ENGINE_FQDN}" \
6969
--keep-key
7070
done
7171
----
72-
<1> Do not change this the password value.
72+
<1> Do not change this password value.
7373

7474
. Restart the *httpd* service:
7575
+
@@ -154,7 +154,7 @@ endif::SHE_upgrade[]
154154

155155
. On the {engine-name}, save a backup of the `/etc/ovirt-engine/engine.conf.d` and `/etc/pki/ovirt-engine` directories, and re-sign the certificates:
156156
+
157-
[source,terminal,subs="normal"]
157+
[source,terminal]
158158
----
159159
# . /etc/ovirt-engine/engine.conf.d/10-setup-protocols.conf
160160
# for name in $names; do
@@ -170,13 +170,13 @@ endif::SHE_upgrade[]
170170
)"
171171
/usr/share/ovirt-engine/bin/pki-enroll-pkcs12.sh \
172172
--name="${name}" \
173-
--password=mypass \ <1>
173+
--password=mypass \ <!--1-->
174174
--subject="${subject}" \
175175
--san=DNS:"${ENGINE_FQDN}" \
176176
--keep-key
177177
done
178178
----
179-
<1> Do not change this the password value.
179+
<1> Do not change this password value.
180180

181181
. Restart the following services:
182182
+

source/documentation/common/upgrade/proc-Updating_all_hosts_in_a_cluster.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Update one cluster at a time.
1111
//Limitations
1212
include::snip-Host_update_limitations.adoc[]
1313

14-
.Procedure
14+
. Procedure
1515

1616
. In the Administration Portal, click menu:Compute[Clusters] and select the cluster. The *Upgrade status* column shows if an upgrade is available for any hosts in the cluster.
1717
. Click *Upgrade*.

source/documentation/common/vgpu/proc_removing-intel-vgpu-devices.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ echo: write error: Device or resource busy
3939
4040
////
4141
[discrete]
42-
== Additional resources
42+
.Additional resources
4343

4444
* A bulleted list of links to other material closely related to the contents of the procedure module.
4545
* For more details on writing procedure modules, see the link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide].

source/documentation/common/vgpu/proc_setting-up-intel-vgpu-devices.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ Windows only: Powering off the virtual machine from within the Windows guest ope
138138

139139
////
140140
[discrete]
141-
== Additional resources
141+
.Additional resources
142142
143143
* A bulleted list of links to other material closely related to the contents of the procedure module.
144144
* For more details on writing procedure modules, see the link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide].

0 commit comments

Comments
 (0)