Uniformly call the project AppWrapper instead of AppWrappers (#339)

Author: dgrove-oss

README.md

@@ -4,13 +4,13 @@
 [![Continuous Integration](https://github.com/project-codeflare/appwrapper/actions/workflows/CI.yaml/badge.svg)](https://github.com/project-codeflare/appwrapper/actions/workflows/CI.yaml)
 
 An AppWrapper contains a collection of Kubernetes resources that a
-user desires to manage as a single logical workload. AppWrappers are
+user desires to manage as a single logical workload. AppWrapper is
 designed to smoothly interoperate with
 [Kueue](https://kueue.sigs.k8s.io).  They provide a flexible and
 workload-agnostic mechanism for enabling Kueue to manage a group of
 Kubernetes resources as a single logical unit without requiring any
 Kueue-specific support by the controllers of those resources.
-Kueue can be configured to recognize AppWrappers as an
+Kueue can be configured to recognize AppWrapper as an
 [externalFramework](https://kueue.sigs.k8s.io/docs/tasks/dev/integrate_a_custom_job/#building-an-external-integration),
 thus ensuring that if you have enabled Kueue's `manageJobsWithoutQueueName`
 option, admission decisions made for the AppWrapper will be properly
@@ -19,7 +19,7 @@ For a more detailed description of the overall design, see the
 [Architecture](https://project-codeflare.github.io/appwrapper/arch-controller/)
 section of our website.
 
-AppWrappers are designed to harden workloads by providing an
+An AppWrapper can be used to harden workloads by providing an
 additional level of automatic fault detection and recovery. The AppWrapper
 controller monitors the health of the workload and if corrective actions
 are not taken by the primary resource controllers within specified deadlines,
@@ -35,15 +35,15 @@ configuring these fault tolerance capabilities, please see the
 [Fault Tolerance](https://project-codeflare.github.io/appwrapper/arch-fault-tolerance/)
 section of our website.
 
-AppWrappers are designed to be used as part of fully open source software stack
+AppWrapper is designed to be used as part of fully open source software stack
 to run production batch workloads on Kubernetes and OpenShift. The [MLBatch](https://github.com/project-codeflare/mlbatch)
 project leverages [Kueue](https://kueue.sigs.k8s.io), the [Kubeflow Training
 Operator](https://www.kubeflow.org/docs/components/training/),
 [KubeRay](https://docs.ray.io/en/latest/cluster/kubernetes/index.html), and the
 [Codeflare Operator](https://github.com/project-codeflare/codeflare-operator)
 from [Red Hat OpenShift
 AI](https://www.redhat.com/en/technologies/cloud-computing/openshift/openshift-ai).
-MLBatch enables [AppWrappers](https://project-codeflare.github.io/appwrapper/)
+MLBatch enables [AppWrapper](https://project-codeflare.github.io/appwrapper/)
 and adds
 [Coscheduler](https://github.com/kubernetes-sigs/scheduler-plugins/blob/master/pkg/coscheduling/README.md).
 MLBatch includes a number of configuration steps to help these components work

kube-state-metrics/README.md

@@ -1,6 +1,6 @@
 This directory contains configuration files for enabling
 [kube-state-metrics](https://github.com/kubernetes/kube-state-metrics/)
-to report metrics for AppWrappers.
+to report metrics for AppWrapper.
 
 The file [appwrapper-ksm-cm.yaml](./appwrapper-ksm-cm.yaml) defines
 a configuration map that can be volume-mounted into the

samples/README.md

@@ -2,7 +2,7 @@
 
 This directory contains a number of example yamls showing how to wrap
 different Pod-creating Kubernetes resources in an AppWrapper.
-AppWrappers can be used to wrap one or more instances of
+An AppWrapper can be used to wrap one or more instances of
 any Kubernetes Kind that uses `PodSpecTemplate` to define its Pods.
 An AppWrapper must contain at least one such Pod-creating resource in addition
 to zero or more non-Pod-creating resources.

site/_config.yml

@@ -13,9 +13,9 @@
 # you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
 # You can create any custom variable you would like, and they will be accessible
 # in the templates via {{ site.myvariable }}.
-title: "Project CodeFlare: AppWrappers"
+title: "Project CodeFlare: AppWrapper"
 description: >- #
-  Project Codeflare: AppWrappers
+  Project Codeflare: AppWrapper
 minimal_mistakes_skin: contrast
 
 # Build settings

site/_pages/overview.md

@@ -9,14 +9,14 @@ classes: wide
 ---
 
 An AppWrapper contains a collection of Kubernetes resources that a
-user desires to manage as a single logical workload. AppWrappers are
+user desires to manage as a single logical workload. AppWrapper is
 designed to smoothly interoperate with
 [Kueue](https://kueue.sigs.k8s.io).  They provide a flexible and
 workload-agnostic mechanism for enabling Kueue to manage a group of
 Kubernetes resources as a single logical unit without requiring any
 Kueue-specific support by the controllers of those resources.
 
-AppWrappers are designed to harden workloads by providing an
+An AppWrapper can be used to harden workloads by providing an
 additional level of automatic fault detection and recovery. The AppWrapper
 controller monitors the health of the workload and if corrective actions
 are not taken by the primary resource controllers within specified deadlines,
@@ -32,15 +32,15 @@ configuring these fault tolerance capabilities, please see the
 [Fault Tolerance](https://project-codeflare.github.io/appwrapper/arch-controller/)
 section of our website.
 
-AppWrappers are designed to be used as part of fully open source software stack
+AppWrapper is designed to be used as part of fully open source software stack
 to run production batch workloads on Kubernetes and OpenShift. The [MLBatch](https://github.com/project-codeflare/mlbatch)
 project leverages [Kueue](https://kueue.sigs.k8s.io), the [Kubeflow Training
 Operator](https://www.kubeflow.org/docs/components/training/),
 [KubeRay](https://docs.ray.io/en/latest/cluster/kubernetes/index.html), and the
 [Codeflare Operator](https://github.com/project-codeflare/codeflare-operator)
 from [Red Hat OpenShift
 AI](https://www.redhat.com/en/technologies/cloud-computing/openshift/openshift-ai).
-MLBatch enables [AppWrappers](https://project-codeflare.github.io/appwrapper/)
+MLBatch enables [AppWrapper](https://project-codeflare.github.io/appwrapper/)
 and adds
 [Coscheduler](https://github.com/kubernetes-sigs/scheduler-plugins/blob/master/pkg/coscheduling/README.md).
 MLBatch includes a number of configuration steps to help these components work

site/_pages/quick-start.md

@@ -66,7 +66,7 @@ Install the most recent AppWrapper release by doing:
 kubectl apply --server-side -f https://github.com/project-codeflare/appwrapper/releases/download/{{ site.appwrapper_version }}/install.yaml
 ```
 
-Before continuing, ensure AppWrappers are ready by executing this command:
+Before continuing, ensure AppWrapper is ready by executing this command:
 ```sh
 kubectl -n appwrapper-system wait --timeout=300s --for=condition=Available deployments --all
 ```