search

openshift / openshift-docs

OpenShift 3 and 4 product and community documentation
https://docs.openshift.com
Apache License 2.0
764 stars 1.77k forks source link

Change on-premise to on-premises (or on-prem) for disambiguation #83210

Open wmcdonald404 opened 1 month ago

wmcdonald404 commented 1 month ago

Which section(s) is the issue in?

./404-commercial.html
./applications/index.adoc
./applications/red-hat-marketplace.adoc
./architecture/cicd_gitops.adoc
./architecture/mce-overview-ocp.adoc
./architecture/nvidia-gpu-architecture-overview.adoc
./cloud_experts_tutorials/cloud-experts-getting-started/cloud-experts-getting-started-what-is-rosa.adoc
./contributing_to_docs/term_glossary.adoc
./getting_started/kubernetes-overview.adoc
./getting_started/openshift-overview.adoc
./hosted_control_planes/hcp-backup-restore-dr.adoc
./hosted_control_planes/hcp-deploy/hcp-deploy-bm.adoc
./hosted_control_planes/hcp-deploy/hcp-deploy-non-bm.adoc
./hosted_control_planes/hcp-deploy/hcp-deploy-virt.adoc
./hosted_control_planes/hcp_high_availability/hcp-backup-restore-on-premise.adoc
./index-commercial.html
./installing/installing_aws/ipi/installing-aws-outposts.adoc
./installing/installing_nutanix/installing-nutanix-installer-provisioned.adoc
./installing/installing_oci/installing-oci-assisted-installer.adoc
./installing/installing_on_prem_assisted/installing-on-prem-assisted.adoc
./installing/installing_vsphere/installing-vsphere-agent-based-installer.adoc
./installing/installing_vsphere/installing-vsphere-assisted-installer.adoc
./installing/installing_vsphere/preparing-to-install-on-vsphere.adoc
./installing/installing_with_agent_based_installer/preparing-to-install-with-agent-based-installer.adoc
./installing/overview/installing-preparing.adoc
./microshift_configuring/microshift_low_latency/microshift-low-latency.adoc
./microshift_install_rpm_ostree/microshift-embed-in-rpm-ostree.adoc
./microshift_install_rpm_ostree/microshift-embed-in-rpm-ostree-offline-use.adoc
./microshift_storage/index.adoc
./modules/architecture-kubernetes-introduction.adoc
./modules/architecture-platform-introduction.adoc
./modules/hcp-bm-hc-console.adoc
./modules/hcp-mce-acm-relationship-intro.adoc
./modules/hcp-non-bm-hc-console.adoc
./modules/hcp-virt-create-hc-console.adoc
./modules/hosted-cluster-etcd-backup-restore-on-premise.adoc
./modules/installation-vsphere-infrastructure.adoc
./modules/kubernetes-resources.adoc
./modules/migration-migrating-on-prem-to-cloud.adoc
./modules/monitoring-common-terms.adoc
./modules/nodes-edge-remote-workers-network.adoc
./modules/nodes-edge-remote-workers-power.adoc
./modules/nodes-edge-remote-workers-strategies.adoc
./modules/nw-metallb-infra-considerations.adoc
./modules/olm-why-use-operators.adoc
./modules/openshift-architecture-common-terms.adoc
./modules/openshift-storage-common-terms.adoc
./modules/ossm-threescale-integrate-1x.adoc
./modules/ossm-threescale-integrate.adoc
./modules/persistent-storage-csi-manila-dynamic-provisioning.adoc
./modules/persistent-storage-local-discovery.adoc
./modules/policy-shared-responsibility.adoc
./modules/registry-configuring-registry-storage-rhodf-cephfs.adoc
./modules/registry-configuring-registry-storage-rhodf-cephrgw.adoc
./modules/registry-configuring-registry-storage-rhodf-nooba.adoc
./modules/rosa-policy-change-management.adoc
./modules/rosa-sts-interactive-cluster-creation-mode-options.adoc
./modules/security-registries-quay.adoc
./modules/understanding-openshift.adoc
./modules/virt-about-services.adoc
./networking/k8s_nmstate/k8s-nmstate-about-the-k8s-nmstate-operator.adoc
./nodes/edge/nodes-edge-remote-workers.adoc
./nodes/nodes/nodes-nodes-adding-node-iso.adoc
./osd_whats_new/osd-whats-new.adoc
./post_installation_configuration/cluster-tasks.adoc
./rosa_release_notes/rosa-release-notes.adoc
./scripts/ocpdocs/index-commercial.html
./scripts/ocpdocs/_previewpage
./scripts/ocpdocs/search-commercial.html
./scripts/ocpdocs/_topnav_other.html
./search-commercial.html
./security/container_security/security-storage.adoc
./storage/container_storage_interface/persistent-storage-csi-azure-stack-hub.adoc
./storage/index.adoc
./_templates/_topnav_other.html
./_topic_maps/_topic_map.yml
./virt/vm_networking/virt-networking-overview.adoc

What needs fixing?

There are 102 references to 'on-premise' in the documentation codebase. 

wmcdonald@fedora:~/repos/personal/openshift-docs$ grep --exclude-dir=.git/ -or on-premise . | wc -l
102

These entries should ideally read 'on-premises', or the shorter form 'on-prem'.

Compare https://dictionary.cambridge.org/dictionary/english/premises vs. https://dictionary.cambridge.org/dictionary/english/premise

Further discussion:

https://collectivecontent.agency/2018/04/19/should-i-say-on-premise-or-on-premises-it/ https://www.adamfowlerit.com/2017/04/premise-vs-premises-cares/

I'll happily submit a PR but just wanted to know if the changes are welcome before doing the work.

apinnick commented 1 month ago

Red Hat Supplementary Style Guide, on-premise, says to this term with caution:

Substitute "on-site" or "in-house" for "on-premise" whenever possible. Although "on-premises" is grammatically correct, "on-premise" is preferred by the industry and the Red Hat Cloud business unit. Capitalize "on-premise" only when using it as part of the name of the Red Hat product "Red Hat Storage Server for On-premise". For Red Hat OpenShift Container Platform, on-premise is a collective term for grouping the bare-metal, VMware vSphere, Nutanix, and Red Hat OpenStack Platform (RHOSP) platforms, so you can use the term in this context.

Incorrect forms: on premise, on-premises, on-prem

You could open an issue in the RHSSG repo.

mburke5678 commented 2 weeks ago

@wmcdonald404 Thanks for the thought. However, according to the Red Hat supplementary style guide for product documentation (probably internal-only)

Although "on-premises" is grammatically correct, "on-premise" is preferred by the industry and the Red Hat Cloud business unit.

We should probably switch the 33 cases of "on-premises" to "on-premise" instead!

wmcdonald404 commented 2 weeks ago

Thanks @mburke5678. I traced the thread of reasoning through from the RHSSG style guide, to the IBM style guide... at which point I decided to cut my losses.

I think that the IBM guide is wrong and the discussion and subsequent justification made little sense when I RTFMed a month back, but I'm not sure I have the patience of pedantry to fight that good fight.

Premise != premises.