redhat-documentation / vale-at-red-hat

Vale config files, styles, and docs to help individuals and teams roll out Vale
https://redhat-documentation.github.io/vale-at-red-hat/
MIT License
37 stars 58 forks source link

Generated Vale rules bare-metal-n.yml and bare-metal-adj.yml offer conflicting advice #29

Closed aireilly closed 2 years ago

aireilly commented 3 years ago

In the RH SSG, "bare metal" is correct in the noun form, while "bare-metal" is correct when used as an adjective. Currently, the generated Vale rules bare-metal-n.yml and bare-metal-adj.yml offer conflicting advice.

https://redhat-documentation.github.io/supplementary-style-guide/#bare-metal-adj

https://redhat-documentation.github.io/supplementary-style-guide/#bare-metal-noun

rolfedh commented 3 years ago

Below, I'll show you instances of " bare-metal" and "bare metal" in the documentation. For " bare-metal", I inserted a space before the string to avoid including many filenames and ids in the search results.

rolfedh commented 3 years ago

Here are the 22 results for " bare-metal".

Results for " bare-metal" in "openshift-docs/*.adoc"

/home/rdlugyhe/openshift-docs/release_notes/ocp-4-7-release-notes.adoc:
  1188:  * The Ironic API service that is embedded in bare-metal installer-provisioned infrastructure now uses

/home/rdlugyhe/openshift-docs/installing/install_config/installing-customizing.adoc:
  20:  when installing bare-metal nodes.

/home/rdlugyhe/openshift-docs/networking/configuring_ingress_cluster_traffic/configuring-externalip.adoc:
  10:  This functionality is generally most useful for clusters installed on bare-metal hardware.

/home/rdlugyhe/openshift-docs/rest_api/config_apis/network-config-openshift-io-v1.adoc:
  135:  LoadBalancer. In general, this is only useful for bare-metal clusters. In OpenShift 3.x, this was misleadingly

/home/rdlugyhe/openshift-docs/modules/cnf-installing-the-performance-addon-operator.adoc:
  19:  * A cluster installed on bare-metal hardware.

/home/rdlugyhe/openshift-docs/modules/installation-osp-deploying-bare-metal-machines.adoc:
  52:  .. If you want to use bare-metal control plane machines, change the value of `controlPlane.platform.openstack.type`
  80:  <1> If you want to have bare-metal control plane machines, change this value to a bare metal flavor.
  92:  .. If you want to use bare-metal control plane machines, change the value of `os_flavor_master` to a bare
  112:  <1> If you want to have bare-metal control plane machines, change this value to a bare metal flavor.

/home/rdlugyhe/openshift-docs/modules/installation-user-infra-machines-static-network.adoc:
  191:  use `coreos.inst.insecure`. This is because the bare-metal media are not GPG-signed for {product-title}.

/home/rdlugyhe/openshift-docs/modules/ipi-install-diagnosing-duplicate-mac-address.adoc:
  4:  If the MAC address of an existing bare-metal node in the cluster matches the MAC address of a bare-metal
  4:  node in the cluster matches the MAC address of a bare-metal host you are attempting to add to the cluster,
  4:  retries the installation continuously. A registration error is displayed for the failed bare-metal host.
  6:  diagnose a duplicate MAC address by examining the bare-metal hosts that are running in the `openshift-machine-api`
  16:  To determine whether a bare-metal host that fails provisioning has the same MAC address as an existing
  18:  . Get the bare-metal hosts running in the `openshift-machine-api` namespace:

/home/rdlugyhe/openshift-docs/modules/machineset-osp-adding-bare-metal.adoc:
  2:  = Adding bare-metal compute machines to a {rh-openstack} cluster
  6:  You can add bare-metal compute machines to an {product-title} cluster after you deploy it
  93:  You can now use bare-metal compute machines in your {product-title} cluster.

/home/rdlugyhe/openshift-docs/modules/nw-ptp-installing-operator.adoc:
  17:  * A cluster installed on bare-metal hardware with nodes that have hardware that supports PTP.

/home/rdlugyhe/openshift-docs/modules/nw-sriov-installing-operator.adoc:
  27:  * A cluster installed on bare-metal hardware with nodes that have hardware that supports SR-IOV.
  121:  * A cluster installed on bare-metal hardware with nodes that have hardware that supports SR-IOV.
rolfedh commented 3 years ago

Here are the 258 results for "bare metal":

Results for "bare metal" in "openshift-docs/*.adoc"

/home/rdlugyhe/openshift-docs/installing/installing-fips.adoc:
  74:  xref:../installing/installing_bare_metal/installing-bare-metal.adoc#installing-bare-metal[Bare metal]

/home/rdlugyhe/openshift-docs/installing/installing-mirroring-installation-images.adoc:
  80:  installing-restricted-networks-bare-metal.adoc#installing-restricted-networks-bare-metal[bare metal], or xref:../installing/installing_aws/installing-restricted-networks-aws.adoc#installing-restricted-networks-aws[Amazon

/home/rdlugyhe/openshift-docs/installing/installing-preparing.adoc:
  28:  * Bare metal or other platform agnostic infrastructure
  52:  and xref:../installing/installing_bare_metal_ipi/ipi-install-overview#ipi-install-overview[bare metal].
  56:  installing_bare_metal/installing-bare-metal.adoc#installing-bare-metal[bare metal installation] procedure.
  65:  installing-restricted-networks-bare-metal.adoc#installing-restricted-networks-bare-metal[bare metal]. You can also install a cluster into a restricted
  109:  ||AWS |Azure |GCP |OpenStack |RHV |Bare metal |vSphere |VMC |IBM Z |IBM Power
  112:  ||AWS |Azure |GCP |OpenStack |oVirt |Bare metal |vSphere |VMC |IBM Z |IBM Power
  204:  ||AWS |Azure |GCP |OpenStack |RHV |Bare metal |vSphere |VMC |IBM Z |IBM Power
  207:  ||AWS |Azure |GCP |OpenStack |oVirt |Bare metal |vSphere |VMC |IBM Z |IBM Power

/home/rdlugyhe/openshift-docs/machine_management/deploying-machine-health-checks.adoc:
  26:  You can configure and deploy a machine health check to detect and repair unhealthy bare metal nodes.

/home/rdlugyhe/openshift-docs/migrating_from_ocp_3_to_4/premigration-checklists.adoc:
  71:  installing_bare_metal/installing-bare-metal.adoc#minimum-resource-requirements_installing-bare-metal[bare metal].

/home/rdlugyhe/openshift-docs/migration-toolkit-for-containers/premigration-checklists.adoc:
  13:  installing_bare_metal/installing-bare-metal.adoc#minimum-resource-requirements_installing-bare-metal[bare metal].

/home/rdlugyhe/openshift-docs/networking/configuring-ptp.adoc:
  19:  PTP Operator works with PTP-capable devices on clusters provisioned only on bare metal infrastructure.

/home/rdlugyhe/openshift-docs/networking/using-sctp.adoc:
  2:  = Using the Stream Control Transmission Protocol (SCTP) on a bare metal cluster

/home/rdlugyhe/openshift-docs/post_installation_configuration/node-tasks.adoc:
  28:  You can add more {op-system-first} compute machines to your {product-title} cluster on bare metal.
  30:  compute machines to a cluster that you installed on bare metal infrastructure, you must create {op-system} machines
  35:  * You installed a cluster on bare metal.

/home/rdlugyhe/openshift-docs/registry/configuring-registry-operator.adoc:
  49:  == Image Registry on bare metal and vSphere
  66:  configuring-registry-storage-baremetal.adoc#configuring-registry-storage-baremetal[Configuring the registry for bare metal]

/home/rdlugyhe/openshift-docs/release_notes/ocp-4-7-release-notes.adoc:
  51:  several improvements to disk provisioning for bare metal deployments. The following features are currently
  142:  ==== Installing a cluster on {rh-openstack} that uses bare metal machines
  144:  {rh-openstack-first} infrastructure that uses bare metal machines. The cluster can have both control plane
  144:  control plane and compute machines running on bare metal, or just compute machines. For more information,
  144:  installing-openstack-user.adoc#installation-osp-deploying-bare-metal-machines_installing-openstack-user[Deploying a cluster with bare metal machines].
  192:  static IP address to the bootstrap host of a bare metal installation that used installer-provisioned infrastructure.
  197:  installer for installer-provisioned installation on bare metal nodes now automatically creates a storage pool
  199:  installer for installer-provisioned installation on bare metal nodes provides a survey which asks the user a
  204:  deployed with installer-provisioned installation on bare metal clusters can deploy with static IP addresses.
  405:  using installer-provisioned infrastructure on bare metal nodes. Deploying a cluster with Secure Boot requires
  420:  * Bare metal hardware
  677:  the BareMetalHost API is set to `false`, the Bare Metal Operator shuts down nodes "hard." That is, it
  677:  does not shut down the node within three minutes, the Bare Metal Operator executes a "hard" shutdown.
  837:  ==== HWMon data collection for hardware telemetry for bare metal clusters
  839:  enabled for hardware health telemetry such as CPU temperature and fan speeds for bare metal clusters.
  1097:  When using installer-provisioned installation on bare metal nodes, {product-title} 4.6 required providing
  1097:  using installer provisioned infrastructure on bare metal nodes and deploying without a `provisioning` network.
  1158:  *Bare Metal Hardware Provisioning*
  1174:  was not handled correctly and caused duplicate bare metal hosts registration. (link:https://bugzilla.redhat.com
  1176:  syslinux-nonlinux package was not included with bare metal provisioning images. As a result, virtual media
  1185:  * Bare metal installations on installer-provisioned infrastructure no longer silently skip writing an
  1206:  * Previously, the bare metal actuator deleted the underlying host by also deleting the `Machine` object,
  1389:  * Bare metal provisioning now does not fail if there is a small, up to one hour, clock skew between the
  1395:  not setting the appropriate metadata on their bare metal flavors. Validations are now skipped on flavors
  1417:  for the installer-provisioned infrastructure bare metal installation method incorrectly used the `provisioningHostIP`
  2059:  * When attempting an IPI installation on bare metal using the latest Dell firmware (04.40.00.00) nodes

/home/rdlugyhe/openshift-docs/scalability_and_performance/managing-bare-metal-hosts.adoc:
  2:  = Managing bare metal hosts
  8:  When you install {product-title} on a bare metal cluster, you can provision and manage bare metal nodes
  8:  bare metal cluster, you can provision and manage bare metal nodes using `machine` and `machineset` custom
  8:  using `machine` and `machineset` custom resources (CRs) for bare metal hosts that exist in the cluster.
  15:  adding-bare-metal-compute-user-infra.adoc#adding-bare-metal-compute-user-infra[Adding compute machines to bare metal]
  24:  deploying-machine-health-checks.adoc#machine-health-checks-bare-metal_deploying-machine-health-checks[MachineHealthChecks on bare metal]

/home/rdlugyhe/openshift-docs/scalability_and_performance/optimizing-networking.adoc:
  18:  Cloud, VM, and bare metal CPU performance can be capable of handling much more than one Gbps network throughput.

/home/rdlugyhe/openshift-docs/modules/about-bare-metal-hosts-and-nodes.adoc:
  6:  = About bare metal hosts and nodes
  8:  To provision a {op-system-first} bare metal host as a node in your cluster, first create a `MachineSet`
  8:  resource (CR) object that corresponds to the bare metal host hardware. Bare metal host machine sets describe
  8:  corresponds to the bare metal host hardware. Bare metal host machine sets describe infrastructure components
  10:  {product-title} uses `Machine` CR's to provision the bare metal node that corresponds to the host as specified

/home/rdlugyhe/openshift-docs/modules/adding-bare-metal-host-to-cluster-using-web-console.adoc:
  6:  = Adding a bare metal host to the cluster using the web console
  8:  You can add bare metal hosts to the cluster in the web console.
  12:  * Install an {op-system} cluster on bare metal.
  17:  . In the web console, navigate to *Compute* -> *Bare Metal Hosts*.
  19:  . Specify a unique name for the new bare metal host.
  25:  of replicas to match the number of available bare metal hosts. Navigate to *Compute* -> *MachineSets*,
  29:  You can also manage the number of bare metal nodes using the `oc scale` command and the appropriate bare
  29:  the number of bare metal nodes using the `oc scale` command and the appropriate bare metal machine set.

/home/rdlugyhe/openshift-docs/modules/adding-bare-metal-host-to-cluster-using-yaml.adoc:
  6:  = Adding a bare metal host to the cluster using YAML in the web console
  8:  You can add bare metal hosts to the cluster in the web console using a YAML file that describes the bare
  8:  bare metal hosts to the cluster in the web console using a YAML file that describes the bare metal host.
  12:  * Install a {op-system} compute machine on bare metal infrastructure for use in the cluster.
  14:  * Create a `Secret` CR for the bare metal host.
  18:  . In the web console, navigate to *Compute* -> *Bare Metal Hosts*.
  38:  CR. The `baremetal-operator` cannot manage the bare metal host without a valid `Secret` referenced in the
  40:  . Select *Create* to save the YAML and create the new bare metal host.
  41:  of replicas to match the number of available bare metal hosts. Navigate to *Compute* -> *MachineSets*,
  45:  You can also manage the number of bare metal nodes using the `oc scale` command and the appropriate bare
  45:  the number of bare metal nodes using the `oc scale` command and the appropriate bare metal machine set.

/home/rdlugyhe/openshift-docs/welcome/index.adoc:
  42:  installing-bare-metal.adoc#installing-bare-metal[Install a cluster on bare metal]**: If none of the available platform and cloud
  42:  available platform and cloud providers meet your needs, you can install {product-title} on bare metal.
  44:  ipi-install-overview.adoc#ipi-install-overview[Install an installer-provisioned cluster on bare metal]**: You can install {product-title} on bare metal
  44:  bare metal]**: You can install {product-title} on bare metal with an installer-provisioned architecture.
  46:  installing-bare-metal.adoc#creating-machines-bare-metal[Create {op-system-first} machines on bare metal]**: You can install {op-system} machines using
  68:  installing_bare_metal/installing-restricted-networks-bare-metal.adoc#installing-restricted-networks-bare-metal[bare metal]

/home/rdlugyhe/openshift-docs/whats_new/new-features.adoc:
  51:  AWS, bare metal, or vSphere hosts. If you use the installer-provisioned

/home/rdlugyhe/openshift-docs/installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc:
  2:  = Installing a cluster on bare metal with network customizations
  62:  Before you install a cluster on bare metal infrastructure that you provision,

/home/rdlugyhe/openshift-docs/installing/installing_bare_metal/installing-bare-metal.adoc:
  2:  = Installing a cluster on bare metal
  9:  bare metal infrastructure that you provision.
  15:  considerations for non-bare metal platforms. Review the information in the
  68:  Before you install a cluster on bare metal infrastructure that you provision,

/home/rdlugyhe/openshift-docs/installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc:
  2:  = Installing a cluster on bare metal in a restricted network
  9:  bare metal infrastructure that you provision in a restricted network.
  15:  considerations for non-bare metal platforms. Review the information in the
  84:  Before you install a cluster on bare metal infrastructure that you provision,

/home/rdlugyhe/openshift-docs/installing/installing_bare_metal_ipi/ipi-install-overview.adoc:
  6:  provides support for installing {product-title} on bare metal nodes. This guide provides a methodology to achieving
  8:  During installer-provisioned installation on bare metal, the installer on the bare metal node labeled
  8:  installation on bare metal, the installer on the bare metal node labeled as `provisioner` creates a bootstrap

/home/rdlugyhe/openshift-docs/installing/installing_bare_metal_ipi/ipi-install-troubleshooting.adoc:
  11:  of the installer-provisioned installation on bare metal. The diagrams below provide a troubleshooting

/home/rdlugyhe/openshift-docs/installing/installing_ibm_power/installing-ibm-power.adoc:
  13:  Additional considerations exist for non-bare metal platforms. Review the information in the

/home/rdlugyhe/openshift-docs/installing/installing_ibm_power/installing-restricted-networks-ibm-power.adoc:
  13:  Additional considerations exist for non-bare metal platforms. Review the information in the

/home/rdlugyhe/openshift-docs/installing/installing_ibm_z/installing-ibm-z-kvm.adoc:
  18:  Additional considerations exist for non-bare metal platforms. Review the information in the

/home/rdlugyhe/openshift-docs/installing/installing_ibm_z/installing-ibm-z.adoc:
  18:  Additional considerations exist for non-bare metal platforms. Review the information in the

/home/rdlugyhe/openshift-docs/installing/installing_ibm_z/installing-restricted-networks-ibm-z-kvm.adoc:
  18:  Additional considerations exist for non-bare metal platforms. Review the information in the

/home/rdlugyhe/openshift-docs/installing/installing_ibm_z/installing-restricted-networks-ibm-z.adoc:
  18:  Additional considerations exist for non-bare metal platforms. Review the information in the

/home/rdlugyhe/openshift-docs/installing/installing_openstack/installing-openstack-user-sr-iov.adoc:
  51:  created to customize your installation. For example, you can deploy a cluster that uses bare metal machines.

/home/rdlugyhe/openshift-docs/installing/installing_openstack/installing-openstack-user.adoc:
  53:  created to customize your installation. For example, you can deploy a cluster that uses bare metal machines.

/home/rdlugyhe/openshift-docs/jaeger/jaeger_install/rhbjaeger-installation.adoc:
  26:  installing-bare-metal.adoc#installing-bare-metal[Install {product-title} {product-version} on bare metal]

/home/rdlugyhe/openshift-docs/machine_management/user_infra/adding-bare-metal-compute-user-infra.adoc:
  2:  = Adding compute machines to bare metal
  8:  You can add more compute machines to your {product-title} cluster on bare metal.
  12:  installing_bare_metal/installing-bare-metal.adoc#installing-bare-metal[installed a cluster on bare metal].
  23:  compute machines to a cluster that you installed on bare metal infrastructure, you must create {op-system} machines

/home/rdlugyhe/openshift-docs/networking/configuring_ingress_cluster_traffic/configuring-ingress-cluster-traffic-ingress-controller.adoc:
  57:  a cluster on bare metal], and

/home/rdlugyhe/openshift-docs/networking/configuring_ingress_cluster_traffic/configuring-ingress-cluster-traffic-service-external-ip.adoc:
  9:  This is generally useful only for a cluster installed on bare metal hardware.

/home/rdlugyhe/openshift-docs/nodes/edge/nodes-edge-remote-workers.adoc:
  23:  * Remote worker nodes are supported on only bare metal clusters with user-provisioned infrastructure.

/home/rdlugyhe/openshift-docs/registry/configuring_registry_storage/configuring-registry-storage-baremetal.adoc:
  2:  = Configuring the registry for bare metal
  24:  details about configuring registry storage for bare metal, see xref:../../scalability_and_performance/optimizing-storage.adoc#recommended-configurable-storage-technology_persistent-storage[Recommended

/home/rdlugyhe/openshift-docs/service_mesh/v1x/preparing-ossm-installation.adoc:
  17:  installing-bare-metal.adoc#installing-bare-metal[Install {product-title} {product-version} on bare metal]

/home/rdlugyhe/openshift-docs/service_mesh/v2x/preparing-ossm-installation.adoc:
  17:  installing-bare-metal.adoc#installing-bare-metal[Install {product-title} {product-version} on bare metal]

/home/rdlugyhe/openshift-docs/storage/persistent_storage/persistent-storage-ocs.adoc:
  39:  |Deploying Red Hat OpenShift Container Storage to local storage on bare metal infrastructure
  40:  deploying_openshift_container_storage_using_bare_metal_infrastructure//[Deploying OpenShift Container Storage 4.7 using bare metal infrastructure]

/home/rdlugyhe/openshift-docs/virt/install/preparing-cluster-for-virt.adoc:
  11:  installing-bare-metal.adoc#installing-bare-metal[bare metal] infrastructure with Red Hat Enterprise Linux

/home/rdlugyhe/openshift-docs/virt/virtual_machines/importing_vms/virt-importing-vmware-vm.adoc:
  32:  the internal {product-title} image registry on bare metal by updating the Image Registry Operator configuration.

/home/rdlugyhe/openshift-docs/modules/architecture-rhcos-updating-bootloader.adoc:
  22:  is recommended that you use `bootupd` only on bare metal or virtualized hypervisor installations, such

/home/rdlugyhe/openshift-docs/modules/automatically-scaling-machines-to-available-bare-metal-hosts.adoc:
  6:  = Automatically scaling machines to the number of available bare metal hosts
  12:  * Install {op-system} bare metal compute machines for use in the cluster, and create corresponding `BareMetalHost`

/home/rdlugyhe/openshift-docs/modules/baseline-router-performance.adoc:
  53:  When running on bare metal with modern processors, you can expect roughly twice the performance of the

/home/rdlugyhe/openshift-docs/modules/cnf-installing-sriov-fec-operator.adoc:
  26:  * A cluster installed on bare metal hardware.

/home/rdlugyhe/openshift-docs/modules/cnf-provisioning-real-time-and-low-latency-workloads.adoc:
  28:  This procedure is fully supported with bare metal installations using {op-system-first} systems.

/home/rdlugyhe/openshift-docs/modules/compliance-custom-storage.adoc:
  13:  be deployed in a variety of public clouds or bare metal, the Compliance Operator cannot determine available

/home/rdlugyhe/openshift-docs/modules/deploy-red-hat-openshift-container-storage.adoc:
  23:  |Instructions on deploying OpenShift Container Storage to local storage on bare metal infrastructure
  24:  deploying_openshift_container_storage_using_bare_metal_infrastructure/index[Deploying OpenShift Container Storage 4.5 using bare metal infrastructure]

/home/rdlugyhe/openshift-docs/modules/installation-about-restricted-network.adoc:
  54:  access for an installation on bare metal hardware or on VMware vSphere.

/home/rdlugyhe/openshift-docs/modules/installation-approve-csrs.adoc:
  115:  platforms that are not machine API enabled, such as bare metal and other user-provisioned infrastructure, you

/home/rdlugyhe/openshift-docs/modules/installation-bare-metal-config-yaml.adoc:
  49:  = Sample `install-config.yaml` file for bare metal

/home/rdlugyhe/openshift-docs/modules/installation-configure-proxy.adoc:
  55:  For bare metal installations, if you do not assign node IP addresses from the

/home/rdlugyhe/openshift-docs/modules/installation-disk-partitioning-upi-templates.adoc:
  14:  installation-user-infra-machines-advanced.adoc. <-- This module is in use with the following bare metal assemblies:

/home/rdlugyhe/openshift-docs/modules/installation-disk-partitioning.adoc:
  10:  // This content was sourced from the bare metal RHCOS assembly file `modules/installation-user-infra-machines-advanced.adoc`
  10:  partitioning` subheader. "Disk partioning" content in the bare metal assembly is not modularized, so anything in this
  10:  against that file for consistency until such time that the large bare metal assembly can be modularized.

/home/rdlugyhe/openshift-docs/modules/installation-osp-deploying-bare-metal-machines.adoc:
  11:  = Deploying a cluster with bare metal machines
  13:  If you want your cluster to use bare metal machines, modify the
  16:  cluster can have both control plane and compute machines running on bare metal, or just compute machines.
  22:  whether the {rh-openstack} network that you use for bare metal workers supports floating IP addresses or not.
  28:  red_hat_openstack_platform/16.1/html/bare_metal_provisioning/index[Bare Metal service (Ironic)] is enabled and accessible via
  30:  * Bare metal is available as link:https://access.redhat.com/documentation/en-us/red_hat_openstack_platform
  32:  * The {rh-openstack} network supports both VM and bare metal server attachment.
  38:  installer-provisioned network, the {rh-openstack} Bare Metal service (Ironic) is able to listen for and interact
  52:  control plane machines, change the value of `controlPlane.platform.openstack.type` to a bare metal flavor.
  53:  .. Change the value of `compute.platform.openstack.type` to a bare metal flavor.
  56:  .An example bare metal `install-config.yaml` file
  80:  <1> If you want to have bare-metal control plane machines, change this value to a bare metal flavor.
  81:  <2> Change this value to a bare metal flavor to use for compute machines.
  92:  use bare-metal control plane machines, change the value of `os_flavor_master` to a bare metal flavor.
  93:  .. Change the value of `os_flavor_worker` to a bare metal flavor.
  95:  .An example bare metal `inventory.yaml` file
  112:  <1> If you want to have bare-metal control plane machines, change this value to a bare metal flavor.
  113:  <2> Change this value to a bare metal flavor to use for compute machines.
  122:  The installer may time out while waiting for bare metal machines to boot.

/home/rdlugyhe/openshift-docs/modules/installation-osp-describing-cloud-parameters.adoc:
  90:  isolated development environment, you can use a bare metal host that runs CentOS 7. See https://github.com

/home/rdlugyhe/openshift-docs/modules/installation-requirements-user-infra.adoc:
  279:  * 6 IBM Power bare metal servers or 6 LPARs across multiple PowerVM servers
  316:  * 6 IBM Power bare metal servers or 6 LPARs across multiple PowerVM servers

/home/rdlugyhe/openshift-docs/modules/installation-rhv-customizing-install-config-yaml.adoc:
  15:  infrastructure is more similar to installing a cluster on bare metal. Therefore, you delete the ovirt platform section

/home/rdlugyhe/openshift-docs/modules/installation-special-config-encrypt-disk.adoc:
  27:  mode to encrypt your disks is only supported for bare metal and vSphere installations on user-provisioned

/home/rdlugyhe/openshift-docs/modules/installation-special-config-mirrored-disk.adoc:
  21:  . Follow the bare metal install procedure up to the point where you created Ignition configs for your

/home/rdlugyhe/openshift-docs/modules/installation-special-config-rtkernel.adoc:
  23:  This procedure is fully supported with bare metal installations using
  30:  * For a bare metal installation of {product-title}, prepare masters and workers.

/home/rdlugyhe/openshift-docs/modules/installation-user-infra-machines-pxe.adoc:
  10:  manually-provisioned {op-system} nodes, such as bare metal, you must create {op-system} machines for it to

/home/rdlugyhe/openshift-docs/modules/ipi-install-additional-install-config-parameters.adoc:
  26:  install/metal/user-provisioned[Install OpenShift on Bare Metal] page when preparing the provisioner node.
  218:  The `hosts` parameter is a list of separate bare metal assets used to build the cluster.
  229:  | The role of the bare metal node. Either `master` or `worker`.

/home/rdlugyhe/openshift-docs/modules/ipi-install-bmc-addressing-for-dell.adoc:
  88:  `04.40.00.00` for installer-provisioned installations on bare metal deployments. There is a known issue with version
  131:  `04.40.00.00` for installer-provisioned installations on bare metal deployments. There is a known issue with version

/home/rdlugyhe/openshift-docs/modules/ipi-install-configuring-the-install-config-file.adoc:
  99:  . Ensure all bare metal nodes are powered off prior to installing the {product-title} cluster.

/home/rdlugyhe/openshift-docs/modules/ipi-install-diagnosing-duplicate-mac-address.adoc:
  4:  you are attempting to add to the cluster, the Bare Metal Operator associates the host with the existing
  4:  inspection, cleaning, or other Ironic steps fail, the Bare Metal Operator retries the installation continuously.
  10:  * Install an {product-title} cluster on bare metal.

/home/rdlugyhe/openshift-docs/modules/ipi-install-network-requirements.adoc:
  8:  for provisioning the operating system on each bare metal node. Second, installer-provisioned installation

/home/rdlugyhe/openshift-docs/modules/ipi-install-preparing-the-bare-metal-node.adoc:
  7:  = Preparing the bare metal node
  19:  Preparing the bare metal node requires executing the following procedure from the provisioner node.
  35:  . Power off the bare metal node via the baseboard management controller and ensure it is off.
  37:  . Retrieve the user name and password of the bare metal node's baseboard management controller. Then,
  49:  . Create a configuration file for the bare metal node.
  80:  Replace `<num>` for the worker number of the bare metal node in the two `name` fields and the `credentialsName`
  80:  of the password. Replace `<NIC1-mac-address>` with the MAC address of the bare metal node's first NIC.
  83:  Replace `<bmc-ip>` with the IP address of the bare metal node's baseboard management controller.
  87:  If the MAC address of an existing bare metal node matches the MAC address of a bare metal host that you
  87:  bare metal node matches the MAC address of a bare metal host that you are attempting to provision, then
  87:  inspection, cleaning, or other Ironic steps fail, the Bare Metal Operator retries the installation continuously.
  90:  . Create the bare metal node.
  105:  . Power up and inspect the bare metal node.

/home/rdlugyhe/openshift-docs/modules/ipi-install-preparing-the-provisioner-node-for-openshift-install.adoc:
  183:  openshift/install/metal/user-provisioned[Install on Bare Metal with user-provisioned infrastructure], and scroll

/home/rdlugyhe/openshift-docs/modules/ipi-install-provisioning-the-bare-metal-node.adoc:
  6:  = Provisioning the bare metal node
  8:  Provisioning the bare metal node requires executing the following procedure from the provisioner node.
  12:  . Ensure the `PROVISIONING STATUS` is `ready` before provisioning the bare metal node.
  69:  . Check the status of the bare metal node.
  92:  . Once provisioned, ensure the bare metal node is ready.

/home/rdlugyhe/openshift-docs/modules/ipi-install-troubleshooting-cleaning-up-previous-installations.adoc:
  12:  . Power off all bare metal nodes prior to installing the {product-title} cluster:

/home/rdlugyhe/openshift-docs/modules/machine-config-overview.adoc:
  21:  config. In other cases, you might need to do bare metal installation where you pass kernel arguments at
  67:  following procedures. See descriptions of {op-system} bare metal installation for system configuration tasks that

/home/rdlugyhe/openshift-docs/modules/machine-health-checks-resource.adoc:
  10:  for all cloud-based installation types, and other than bare metal, resembles the following YAML file:

/home/rdlugyhe/openshift-docs/modules/machine-user-infra-machines-iso.adoc:
  9:  more {op-system-first} compute machines for your bare metal cluster by using an ISO image to create the machines.

/home/rdlugyhe/openshift-docs/modules/machine-user-infra-machines-pxe.adoc:
  9:  create more {op-system-first} compute machines for your bare metal cluster by using PXE or iPXE booting.

/home/rdlugyhe/openshift-docs/modules/machineset-osp-adding-bare-metal.adoc:
  18:  red_hat_openstack_platform/16.1/html/bare_metal_provisioning/index[Bare Metal service (Ironic)] is enabled and accessible by
  20:  * Bare metal is available as link:https://access.redhat.com/documentation/en-us/red_hat_openstack_platform
  25:  subnet and the pre-existing bare metal subnet.
  28:  . Create a file called `baremetalMachineSet.yaml`, and then add the bare metal flavor to it:
  31:  .A sample bare metal MachineSet file

/home/rdlugyhe/openshift-docs/modules/maintaining-bare-metal-hosts.adoc:
  6:  = Maintaining bare metal hosts
  8:  You can maintain the details of the bare metal hosts in your cluster from the {product-title} web console.
  8:  {product-title} web console. Navigate to *Compute* -> *Bare Metal Hosts*, and select a task from the *Actions* drop
  10:  You can move a bare metal host into maintenance mode. When you move a host into maintenance mode, the
  10:  moves all managed workloads off the corresponding bare metal node. No new workloads are scheduled while in
  12:  You can deprovision a bare metal host in the web console. Deprovisioning a host does the following actions
  14:  . Annotates the bare metal host CR with `cluster.k8s.io/delete-machine: true`

/home/rdlugyhe/openshift-docs/modules/mgmt-power-remediation-baremetal-about.adoc:
  6:  = About power-based remediation of bare metal
  7:  In a bare metal cluster, remediation of nodes is critical to ensuring the overall health of the cluster.
  11:  `MachineHealthCheck` controller to detect faulty bare metal nodes. Power-based remediation is fast and reboots
  20:  == MachineHealthChecks on bare metal
  22:  Machine deletion on bare metal cluster triggers reprovisioning of a bare metal host.
  22:  Machine deletion on bare metal cluster triggers reprovisioning of a bare metal host.
  23:  Usually bare metal reprovisioning is a lengthy process, during which the cluster
  38:  . The MHC notifies the bare metal machine controller which requests to power-off the unhealthy node.
  40:  . The bare metal machine controller requests to power on the node.
  42:  . After the node is recreated, the bare metal machine controller restores the annotations and labels that
  46:  If the power operations did not complete, the bare metal machine controller triggers the reprovisioning
  50:  == Creating a MachineHealthCheck resource for bare metal
  67:  .Sample `MachineHealthCheck` resource for bare metal
  95:  <2> For bare metal clusters, you must include the `machine.openshift.io/remediation-strategy: external-baremetal`

/home/rdlugyhe/openshift-docs/modules/nodes-nodes-rtkernel-arguments.adoc:
  15:  The following procedure is fully supported with bare metal installations that use systems that are certified

/home/rdlugyhe/openshift-docs/modules/nodes-nodes-working-deleting-bare-metal.adoc:
  7:  = Deleting nodes from a bare metal cluster
  17:  Delete a node from an {product-title} cluster running on bare metal by completing

/home/rdlugyhe/openshift-docs/modules/nodes-nodes-working-deleting.adoc:
  20:  If you are running cluster on bare metal, you cannot delete a node by editing

/home/rdlugyhe/openshift-docs/modules/nodes-nodes-working-master-schedulable.adoc:
  16:  You can deploy {product-title} with no worker nodes on a bare metal cluster. 

/home/rdlugyhe/openshift-docs/modules/nw-egress-ips-about.adoc:
  39:  | Bare metal | Yes

/home/rdlugyhe/openshift-docs/modules/nw-how-nw-iface-selected.adoc:
  11:  For installations on bare metal or with virtual machines that have more than one network interface controller

/home/rdlugyhe/openshift-docs/modules/nw-ingress-controller-configuration-parameters.adoc:
  42:  * Bare metal: `NodePortService`

/home/rdlugyhe/openshift-docs/modules/nw-ovn-kubernetes-migration-about.adoc:
  12:  * Bare metal hardware

/home/rdlugyhe/openshift-docs/modules/nw-sriov-networknodepolicy-object.adoc:
  66:  in Data Plane Development Kit (DPDK) mode on bare metal nodes, use the `netdevice` driver type and set

/home/rdlugyhe/openshift-docs/modules/persistent-storage-local-discovery.adoc:
  8:  not available during deployment, such as with bare metal, VMware, or AWS store instances with attached

/home/rdlugyhe/openshift-docs/modules/querying-operator-status-after-installation.adoc:
  56:  platforms that are not machine API enabled, such as bare metal and other user-provisioned infrastructure, you

/home/rdlugyhe/openshift-docs/modules/recommended-configurable-storage-technology.adoc:
  91:  For non-cloud platforms, such as vSphere and bare metal installations, the only configurable technology

/home/rdlugyhe/openshift-docs/modules/registry-configuring-storage-baremetal.adoc:
  27:  = Configuring registry storage for bare metal and other manual installations
  43:  ifndef::ibm-z,ibm-power[that uses manually-provisioned {op-system-first} nodes, such as bare metal.]

/home/rdlugyhe/openshift-docs/modules/rhcos-about.adoc:
  121:  something cloud-init cannot do: set up systems on bare metal from scratch (using features such as PXE boot).
  121:  scratch (using features such as PXE boot). In the bare metal case, the Ignition config is injected into the

/home/rdlugyhe/openshift-docs/modules/security-hardening-how.adoc:
  12:  non-bare metal installs, you can request a new node of the type
  22:  For bare metal installations, you can add hardening features to
  28:  Although bare metal {op-system} installations are more difficult,

/home/rdlugyhe/openshift-docs/modules/security-registries-immutable.adoc:
  18:  * Compatible across the {op-system-base} platforms, from bare metal to cloud

/home/rdlugyhe/openshift-docs/modules/supported-platforms-for-openshift-clusters.adoc:
  39:  * Bare metal
  43:  restricted network installation on vSphere or bare metal infrastructure, your cluster machines do not require

/home/rdlugyhe/openshift-docs/modules/virt-about-the-overview-dashboard.adoc:
  29:  ** Bare metal hosts in the cluster, listed according to their state (only available in *metal3* environment).

/home/rdlugyhe/openshift-docs/modules/virt-maintaining-bare-metal-nodes.adoc:
  6:  = Maintaining bare metal nodes
  8:  When you deploy {product-title} on bare metal infrastructure, there are additional considerations that
  8:  nodes are considered ephemeral, re-provisioning a bare metal node requires significantly more time and effort
  10:  When a bare metal node fails, for example, if a fatal kernel error happens or a NIC card hardware failure

/home/rdlugyhe/openshift-docs/modules/vmc-sizer-tool.adoc:
  14:  VMware Cloud on AWS is built on top of AWS bare metal infrastructure; this is the same bare metal infrastructure
  14:  AWS bare metal infrastructure; this is the same bare metal infrastructure which runs AWS native services.
gaurav-nelson commented 3 years ago

I came across https://github.com/errata-ai/vale/issues/356, its a work in progress, but we can use Vale with spaCy NLP to address this issue. However, it currently it depends on running a local spaCy endpoint (spacy-vale).

So essentially, with this feature, we can have grammar-focused rules to tackle this case and other similar cases.

aireilly commented 3 years ago

@gaurav-nelson wow this looks really cool. have you tried it out?

gaurav-nelson commented 3 years ago

@aireilly I haven't already but want to PS: https://github.com/rolfedh/studious-fortnight/discussions/34