fix grammar

Signed-off-by: Pankaj Walke <[email protected]>

README.md

@@ -1,6 +1,6 @@
 # CNOE AWS Reference Implementation
 
-This project contains a [CNOE](https://cnoe.io) reference implementation for AWS. This project can bring up an Internal Developer Platform on EKS with all the tools configured and ready to use. It will install addons on an EKS cluster as Argo CD apps using GitOps Bridge App of ApplicationSets pattern. Check out [Getting Started](#getting-started) guide for installing this solution on EKS cluster.
+This project contains a [CNOE](https://cnoe.io) reference implementation for AWS. This project can bring up an Internal Developer Platform on EKS with all the tools configured and ready to use. It will install addons on an EKS cluster as Argo CD apps using GitOps Bridge App of ApplicationSets pattern. Check out the [Getting Started](#getting-started) guide for installing this solution on an EKS cluster.
 
 > [!NOTE]
 > Applications deployed in this repository are not meant or configured for production.
@@ -18,8 +18,8 @@ All the addons are helm charts with static values configured in `packages/<addon
 | Argo CD | argocd | Installation and management of addon Argo CD application | 8.0.14 | [Link](https://github.com/argoproj/argo-helm/tree/main/charts/argo-cd) |
 | Argo Workflows | argo | Workflow tool for continuous integration tasks  | 0.45.18 | [Link](https://github.com/argoproj/argo-helm/tree/main/charts/argo-workflows )|
 | Backstage | backstage | Self-Service Web UI (Developer Portal) for developers | 2.6.0 | [Link](https://github.com/backstage/charts/tree/main/charts/backstage) |
-| Cert Manager | cert-manager | Certificate managed for addons and developer applications using Lets Enctrypt | 1.17.2 | [Link](https://cert-manager.io/docs/installation/helm/) |
-| Crossplane | crossplane-system | IaC controller for provisiong infrastructure  | 1.20.0 | [Link](https://github.com/crossplane/crossplane/tree/main/cluster/charts/crossplane) |
+| Cert Manager | cert-manager | Certificate manager for addons and developer applications using Let's Encrypt | 1.17.2 | [Link](https://cert-manager.io/docs/installation/helm/) |
+| Crossplane | crossplane-system | IaC controller for provisioning infrastructure  | 1.20.0 | [Link](https://github.com/crossplane/crossplane/tree/main/cluster/charts/crossplane) |
 | External DNS | external-dns | Domain management using Route 53 | 1.16.1 | [Link](https://github.com/kubernetes-sigs/external-dns/tree/master/charts/external-dns) |
 | External Secrets | external-secrets | Secret Management using AWS Secret Manager and AWS Systems Manager Parameter Store  | Version | [Link](https://github.com/external-secrets/external-secrets/tree/main/deploy/charts/external-secrets) |
 | Ingress NGINX | ingress-nginx | Ingress controller for L7 network traffic routing  | 4.7.0 | [Link](https://github.com/kubernetes/ingress-nginx/tree/main/charts/ingress-nginx) |
@@ -97,12 +97,12 @@ flowchart TD
 
 ### Step 1. ☸️ Create EKS Cluster
 
-The reference implementation can be installed on new EKS cluster which can be created with following tools:
+The reference implementation can be installed on a new EKS cluster which can be created with the following tools:
 
 + **eksctl**: Follow the [instructions](cluster/eksctl)
 + **terraform**: Follow the [instructions](cluster/terraform/)
 
-This will create all the pre-requisite AWS Resources required for the reference implementation. Which includes:
+This will create all the prerequisite AWS Resources required for the reference implementation, which includes:
 
 + EKS cluster with Auto Mode or Without Auto Mode (Managed Node Group with 4 nodes)
 + Pod Identity Associations for following Addons:
@@ -119,26 +119,26 @@ This will create all the pre-requisite AWS Resources required for the reference
 > [!NOTE]
 > **Using Existing EKS Cluster**
 >
-> The reference implementation can be installed on existing EKS Cluster only if above pre-requisites are completed.
+> The reference implementation can be installed on an existing EKS Cluster only if the above prerequisites are completed.
 
 ### Step 2. 🏢 Create GitHub Organization
 
-Backstage and Argo CD in this reference implementation are integrated with GitHub. Both Backstage and ArgoCD, use Github Apps for authenticating with Github.
+Backstage and Argo CD in this reference implementation are integrated with GitHub. Both Backstage and ArgoCD use Github Apps for authenticating with Github.
 
 Therefore, a GitHub Organization should be created in order to create GitHub Apps for these integrations. Follow the instructions in [GitHub documentation](https://docs.github.com/en/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch) to create new organization or visit [here](https://github.com/account/organizations/new).
 
 > [!NOTE]
-> It is recommended to use Github Organization instead of personal github ID as backstage has certain [limitations](https://backstage.io/docs/integrations/github/github-apps/#caveats) for using personal account Github Apps for authenticating to Github. Also, the Github Organization is ***FREE***.
+> It is recommended to use a Github Organization instead of a personal github ID as Backstage has certain [limitations](https://backstage.io/docs/integrations/github/github-apps/#caveats) for using personal account Github Apps for authenticating to Github. Also, the Github Organization is ***FREE***.
 
 ### Step 3. 🍴 Fork the Repository
 
 Once the organization is created, fork this repository to the new GitHub Organization by following instructions in [GitHub documentation](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo).
 
 ### Step 4. 💻 Create GitHub Apps
 
-There are two ways to create GitHub App. You can use the Backstage CLI `npx @backstage/cli create-github-app <github-org>` as per instructions in [Backstage documentation](https://backstage.io/docs/integrations/github/github-apps/#using-the-cli-public-github-only), or create it manually per these instructions in [GitHub documentation](https://backstage.io/docs/integrations/github/github-apps).
+There are two ways to create a GitHub App. You can use the Backstage CLI `npx @backstage/cli create-github-app <github-org>` as per instructions in the [Backstage documentation](https://backstage.io/docs/integrations/github/github-apps/#using-the-cli-public-github-only), or create it manually per these instructions in the [GitHub documentation](https://backstage.io/docs/integrations/github/github-apps).
 
-Create following apps and store it in corresponding file path.
+Create the following apps and store them in the corresponding file path.
 
 | App Name | Purpose | Required Permissions | File Path | Expected Content |
 | -------- | ------- | -------------------- | --------- | ---------------- |
@@ -148,7 +148,7 @@ Create following apps and store it in corresponding file path.
 Argo CD requires `url` and `installationId` of the GitHub app. The `url` is the GitHub URL of the organization. The `installationId` can be captured by navigating to the app installation page with URL `https://github.com/organizations/<Organization-name>/settings/installations/<ID>`. You can find more information [on this page](https://stackoverflow.com/questions/74462420/where-can-we-find-github-apps-installation-id).
 
 > [!WARNING]
-> **If the app is created using backstage CLI, it creates files in current working directory. These files contain credentials. Handle it with care. It is recommended to remove these files after copying the content over to files in `private` directory**
+> **If the app is created using the Backstage CLI, it creates files in the current working directory. These files contain credentials. Handle them with care. It is recommended to remove these files after copying the content over to files in the `private` directory**
 
 > [!NOTE]
 > The rest of the installation process assumes the GitHub apps credentials are available in `private/backstage-github.yaml` and `private/argocd-github.yaml`
@@ -157,27 +157,27 @@ Argo CD requires `url` and `installationId` of the GitHub app. The `url` is the
 
 #### 📦 Install Binaries
 
-The installation requires following binaries in the local environment:
+The installation requires the following binaries in the local environment:
 
 + [**AWS CLI**](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html)
 + [**kubectl**](https://kubernetes.io/docs/tasks/tools/)
 + [**yq**](https://mikefarah.gitbook.io/yq/v3.x)
 + [**helm**](https://helm.sh/docs/intro/install/)
 
 #### 🔐 Configure AWS Credentials
-Configure the AWS CLI with credentials of an IAM role which has access to the EKS cluster. Follow instructions in [AWS documentation](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-quickstart.html#getting-started-quickstart-new) to configure AWS CLI.
+Configure the AWS CLI with credentials of an IAM role which has access to the EKS cluster. Follow the instructions in the [AWS documentation](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-quickstart.html#getting-started-quickstart-new) to configure the AWS CLI.
 
-If the installation steps are being executed on EC2 instance, ensure that the EC2 IAM instance role has permissions to access EKS cluster or The AWS CLI is configured as mentioned above.
+If the installation steps are being executed on an EC2 instance, ensure that the EC2 IAM instance role has permissions to access the EKS cluster or the AWS CLI is configured as mentioned above.
 
 #### ⚙️ Configure Reference Implementation
 
-The reference implementation uses **`config.yaml`** file in the repository root directory to configure the installation values. The **`config.yaml`** should be updated with appropriate values before proceeding. Refer to following table and update all the values appropriately. All the values are required.
+The reference implementation uses **`config.yaml`** file in the repository root directory to configure the installation values. The **`config.yaml`** should be updated with appropriate values before proceeding. Refer to the following table and update all the values appropriately. All the values are required.
 
 | Parameter | Description | Type |
 |-----------|-------------|------|
-| `repo.url` | GitHub URL of the fork in Github Org | string |
-| `repo.revision` | Branch or Tag which should be used for Argo CD Apps | string |
-| `repo.basepath` | Directory in which configuration of addons is stored | string |
+| `repo.url` | GitHub URL of the fork in the Github Org | string |
+| `repo.revision` | Branch or tag which should be used for Argo CD Apps | string |
+| `repo.basepath` | Directory in which the configuration of addons is stored | string |
 | `cluster_name` | Name of the EKS cluster for reference implementation <br> **(The name should satisfy criteria of a valid [kubernetes resource name](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/))** | string |
 | `auto_mode` | Set to "true" if EKS cluster is Auto Mode, otherwise "false" | string |
 | `region` | AWS Region of the EKS cluster and config secret | string |
@@ -187,7 +187,7 @@ The reference implementation uses **`config.yaml`** file in the repository root
 | `tags` | Arbitrary key-value pairs for AWS resource tagging | object |
 
 > [!TIP]
-> If these values are updated after installation. Ensure to run command in next step to update the values in AWS secret manager. Otherwise, the updated values will not reflect in the live installation.
+> If these values are updated after installation, ensure to run the command in the next step to update the values in AWS Secret Manager. Otherwise, the updated values will not reflect in the live installation.
 
 #### 🔒 Create Secrets in AWS Secret Manager
 
@@ -196,7 +196,7 @@ The values required for the installation are stored in AWS Secret Manager in two
 1. **cnoe-ref-impl/config:** Stores values from **`config.yaml`** in JSON
 2. **cnoe-ref-impl/github-app:** Stores GitHub App credentials with file name as key and content of the file as value from **private** directory.
 
-Run below command to create new secrets or update the existing secrets if already exists.
+Run the command below to create new secrets or update the existing secrets if they already exist.
 
 ```bash
 ./scripts/create-config-secrets.sh
@@ -207,36 +207,36 @@ Run below command to create new secrets or update the existing secrets if alread
 
 ### Step 6. 🚀 Installation
 > [!NOTE]
-> Before moving forward, Ensure that the kubectl context is set to EKS cluster and the configured AWS IAM role has access to the cluster.
+> Before moving forward, ensure that the kubectl context is set to the EKS cluster and the configured AWS IAM role has access to the cluster.
 
 #### ▶️ Start the Installation Process
 
-All the addons are installed as Argo CD apps. At the start of the installation, Argo CD and External Secret Operator are installed on EKS cluster as helm chart. Once Argo CD on EKS is up, other addons are installed through it and finally the Argo CD on EKS also manages itself and External Secret Operator. Check out more details about the [installation flow](docs/installation_flow.md). Run following command to start the installation.
+All the addons are installed as Argo CD apps. At the start of the installation, Argo CD and External Secret Operator are installed on the EKS cluster as a helm chart. Once Argo CD on EKS is up, other addons are installed through it and finally the Argo CD on EKS also manages itself and External Secret Operator. Check out more details about the [installation flow](docs/installation_flow.md). Run the following command to start the installation.
    ```bash
    scripts/install.sh
    ```
 
 #### 📊 Monitor Installation Process
 
-The installation script will continue to run until all the Argo CD apps for Addons are healthy. To monitor the process, use below instructions to access instance of Argo CD running on EKS.
+The installation script will continue to run until all the Argo CD apps for addons are healthy. To monitor the process, use the instructions below to access the instance of Argo CD running on EKS.
 
-Check if the kubectl context is set to EKS cluster and it can access the EKS cluster. Then, Start the kubernetes port-forward session for Argo CD service and access the Argo CD UI in browser. In Argo CD UI, monitor the health of all Argo CD Apps
+Check if the kubectl context is set to the EKS cluster and it can access the EKS cluster. Then, start the kubernetes port-forward session for the Argo CD service and access the Argo CD UI in a browser. In the Argo CD UI, monitor the health of all Argo CD Apps
 
   ```bash
   kubectl port-forward -n argocd svc/argocd-server 8080:80
   ```
 
 Depending upon the configuration, Argo CD will be accessible at http://localhost:8080 or http://localhost:8080/argocd.
 
-Retrieve the credentials for Argo CD can be retrieved with following command:
+The credentials for Argo CD can be retrieved with the following command:
 
 ```bash
 kubectl get secrets -n argocd argocd-initial-admin-secret -oyaml | yq '.data.password' | base64 -d && echo
 ```
 
 ### Step 7. 🌐 Accessing the Platform
 
-The addons with Web UI are exposed using the base domain configured in [Step 5](#️-configure-reference-implementation). The URLs can be retrieved by running following command:
+The addons with Web UI are exposed using the base domain configured in [Step 5](#️-configure-reference-implementation). The URLs can be retrieved by running the following command:
 ```
 scripts/get-urls.sh
 ```
@@ -248,25 +248,25 @@ The URL depends on the setting for `path_routing`. Refer to following table for
 | Argo CD | https://[domain]/argocd | https://argocd.[domain] |
 | Argo Workflows | https://[domain]/argo-workflows | https://argo-workflows.[domain] |
 
-All the addons are configured with Keycloak SSO USER1 and the user password for it can be retrieved using following command:
+All the addons are configured with Keycloak SSO USER1 and the user password for it can be retrieved using the following command:
 
 ```bash
 kubectl get secret -n keycloak keycloak-config -o jsonpath='{.data.USER1_PASSWORD}' | base64 -d && echo
 ```
-Once, all the Argo CD apps on EKS cluster are reporting healthy status, try out [examples](docs/examples/) to create new application through Backstage.
+Once all the Argo CD apps on the EKS cluster are reporting healthy status, try out the [examples](docs/examples/) to create a new application through Backstage.
 For troubleshooting, refer to the [troubleshooting guide](docs/troubleshooting.md).
 
 ## Cleanup
 > [!WARNING]
-> Before proceeding with the cleanup, ensure any Kubernetes resource created outside of the installation process such as Argo CD Apps, deployments, volume etc. are deleted.
+> Before proceeding with the cleanup, ensure any Kubernetes resources created outside of the installation process such as Argo CD Apps, deployments, volumes etc. are deleted.
 
-Run following command to remove all the addons created by this installation:
+Run the following command to remove all the addons created by this installation:
 
 ```
 scripts/uninstall.sh
 ```
 
-This script will only remove resources other than CRDs from the EKS cluster so that the same cluster can used for re-installation which is useful during development. To remove CRDs, use following command:
+This script will only remove resources other than CRDs from the EKS cluster so that the same cluster can be used for re-installation which is useful during development. To remove CRDs, use the following command:
 
 ```
 scripts/cleanup-crds.sh

cluster/eksctl/README.md

@@ -8,7 +8,7 @@ This directory contains the configuration to create an EKS cluster with pod iden
 - eksctl installed
 
 ## Create Cluster
-Run following command and follow instructions:
+Run the following command and follow the instructions:
 
 ```bash
 export REPO_ROOT=$(git rev-parse --show-toplevel)
@@ -27,13 +27,13 @@ The cluster creation will provision the following AWS resources:
 - EKS cluster security groups
 - OIDC identity provider
 
-### Managed Node Group _(For Non-Auto mode cluster)_
+### Managed Node Group _(For Non-Auto Mode cluster)_
 - Managed node group with 3-6 m5.large instances
 - Desired capacity: 4 nodes
 - 100GB EBS volumes per node
 - Node IAM role with required policies
 
-### EKS Addons _(For Non-Auto mode cluster)_
+### EKS Addons _(For Non-Auto Mode cluster)_
 - eks-pod-identity-agent
 - aws-ebs-csi-driver with EBS CSI controller policies
 - vpc-cni (default)
@@ -66,7 +66,7 @@ eksctl delete cluster --name $CLUSTER_NAME --region $AWS_REGION
 aws iam delete-policy --policy-arn $CROSSPLANE_BOUNDARY_POLICY_ARN
 ```
 
-This will automatically clean up:
+This will automatically clean up the following:
 - EKS cluster
 - Managed node groups
 - Pod identity associations