Minor edits.

cloudbees · Sep 10, 2024 · 4b9e09a · 4b9e09a
1 parent d99fbbb
commit 4b9e09a
Show file tree

Hide file tree

Showing 7 changed files with 63 additions and 62 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -14,10 +14,10 @@ This document provides guidelines for contributing to the CloudBees CI add-on fo
       - The `source` field in the `eks_blueprints_addon_cbci` at blueprints must point to the remote [terraform registry version](https://registry.terraform.io/modules/cloudbees/cloudbees-ci-eks-addon/aws/latest) and `version >= "x.x.x"`. It is important for the telemetry in https://registry.terraform.io/modules/cloudbees/cloudbees-ci-eks-addon/aws/latest.
       - The CasC bundles SCM configuration must point to the https://github.com/cloudbees/terraform-aws-cloudbees-ci-eks-addon repository and its `main` branch.
   - `develop` branch:
-    - It is the integration branch and it is used for testing new features and updates before merging them into the `main` branch.
+    - It is the integration branch, and is used for testing new features and updates before merging them into the `main` branch.
     - Requirements:
-      - The `source` field in the `eks_blueprints_addon_cbci` in the blueprints folder must point to the local root of the https://github.com/cloudbees/terraform-aws-cloudbees-ci-eks-addon repository (for example, `source = "../../"`).
-      - The CasC bundles SCM configuration must point to the https://github.com/cloudbees/terraform-aws-cloudbees-ci-eks-addon repository and its `develop` branch.
+      - The `source` field in the `eks_blueprints_addon_cbci` in the blueprints folder must point to the local root of the [terraform-aws-cloudbees-ci-eks-addon](https://github.com/cloudbees/terraform-aws-cloudbees-ci-eks-addon) repository (for example, `source = "../../"`).
+      - The CasC bundles SCM configuration must point to the `develop` branch in the [terraform-aws-cloudbees-ci-eks-addon](https://github.com/cloudbees/terraform-aws-cloudbees-ci-eks-addon) repository.
 
 ## Report bugs and feature requests
 
@@ -54,7 +54,7 @@ To submit a pull request:
 7. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
 
 > [!IMPORTANT]
-> If you make updates to embeded repository (e.g. CasC bundles), you must push the changes to the public upstream (repository/branch) before running `terraform apply` locally. The endpoint and/or branch can be updated via `set-casc-location` from the companion [Makefile](Makefile).
+> If you make updates to embedded repository (for example, CasC bundles), you must push the changes to the public upstream (repository/branch) before running `terraform apply` locally. The endpoint and/or branch can be updated via `set-casc-location` from the companion [Makefile](Makefile).
 
 ### Pre-commits: Linting, formatting and secrets scanning
 
@@ -73,7 +73,7 @@ Validate your pull request changes inside the blueprint agent described in the [
 The [bp-tf-ci.yaml](.cloudbees/workflows/bp-tf-ci.yaml) blueprints are orchestrated into the [CloudBees platform](https://www.cloudbees.com/products/saas-platform) inside the [CloudBees Professional Services (PS) sub-organization](https://cloudbees.io/orgs/cloudbees~professional-services/components/94c50dcf-125e-4767-b9c5-58d6d669a1f6/runs).
 
 > [!NOTE]
-> At the time of writing, the pipeline triggers on `push` events only and not for `pull_requests`. Although pull request event is supported, it is requires filters for file patters ()`*.tf`).
+> The pipeline triggers on `push` events only, and does not trigger for `pull_requests`. Although the `pull_requests` event is supported, it requires filters for file patters (for example, `*.tf`).
 
 #### Prerequisites
 

diff --git a/README.md b/README.md
@@ -105,18 +105,18 @@ The CloudBees CI add-on uses `helms release` for its resources definition, makin
 
 ### Outputs
 
-| Name | Description |
-|------|-------------|
-| cbci_domain_name | Amazon Route 53 domain name to host CloudBees CI services. |
-| cbci_liveness_probe_ext | Operations center service external liveness probe for the CloudBees CI add-on. |
-| cbci_liveness_probe_int | Operations center service internal liveness probe for the CloudBees CI add-on. |
-| cbci_namespace | Namespace for the CloudBees CI add-on. |
-| cbci_oc_ing | Operations center Ingress for the CloudBees CI add-on. |
-| cbci_oc_pod | Operations center pod for the CloudBees CI add-on. |
-| cbci_oc_url | Operations center URL for the CloudBees CI add-on using a subdomain and certificates. |
-| cbci_sec_casc | Optional. Kubernetes secrets name for CloudBees CI Casc. |
-| cbci_sec_registry | Optional. Kubernetes secrets name for CloudBees CI agents to autheticate to registry. |
-| merged_helm_config | (merged) Helm configuration for CloudBees CI. |
+| Name                    | Description                                                                           |
+|-------------------------|---------------------------------------------------------------------------------------|
+| cbci_domain_name        | Amazon Route 53 domain name to host CloudBees CI services.                            |
+| cbci_liveness_probe_ext | Operations center service external liveness probe for the CloudBees CI add-on.        |
+| cbci_liveness_probe_int | Operations center service internal liveness probe for the CloudBees CI add-on.        |
+| cbci_namespace          | Namespace for the CloudBees CI add-on.                                                |
+| cbci_oc_ing             | Operations center Ingress for the CloudBees CI add-on.                                |
+| cbci_oc_pod             | Operations center pod for the CloudBees CI add-on.                                    |
+| cbci_oc_url             | Operations center URL for the CloudBees CI add-on using a subdomain and certificates. |
+| cbci_sec_casc           | Optional. Kubernetes secrets name for CloudBees CI Casc.                              |
+| cbci_sec_registry       | Optional. Kubernetes secrets name for CloudBees CI agents to autheticate to registry. |
+| merged_helm_config      | (merged) Helm configuration for CloudBees CI.                                         |
 <!-- END_TF_DOCS -->
 
 ## Additional resources

diff --git a/blueprints/01-getting-started/README.md b/blueprints/01-getting-started/README.md
@@ -39,22 +39,22 @@ This blueprint presents the minimum setup to run CloudBees CI on Amazon EKS; one
 
 ### Outputs
 
-| Name | Description |
-|------|-------------|
-| acm_certificate_arn | AWS Certificate Manager (ACM) certificate for Amazon Resource Names (ARN). |
-| cbci_helm | Helm configuration for the CloudBees CI add-on. It is accessible via state files only. |
-| cbci_initial_admin_password | Operations center service initial admin password for the CloudBees CI add-on. |
-| cbci_liveness_probe_ext | Operations center service external liveness probe for the CloudBees CI add-on. |
-| cbci_liveness_probe_int | Operations center service internal liveness probe for the CloudBees CI add-on. |
-| cbci_namespace | Namespace for the CloudBees CI add-on. |
-| cbci_oc_ing | Operations center Ingress for the CloudBees CI add-on. |
-| cbci_oc_pod | Operations center pod for the CloudBees CI add-on. |
-| cbci_oc_url | URL of the CloudBees CI operations center for the CloudBees CI add-on. |
-| eks_cluster_arn | Amazon EKS cluster ARN. |
-| eks_cluster_name | Amazon EKS cluster Name. |
-| kubeconfig_add | Add kubeconfig to your local configuration to access the Kubernetes API. |
-| kubeconfig_export | Export the KUBECONFIG environment variable to access the Kubernetes API. |
-| vpc_arn | VPC ID. |
+| Name                        | Description                                                                            |
+|-----------------------------|----------------------------------------------------------------------------------------|
+| acm_certificate_arn         | AWS Certificate Manager (ACM) certificate for Amazon Resource Names (ARN).             |
+| cbci_helm                   | Helm configuration for the CloudBees CI add-on. It is accessible via state files only. |
+| cbci_initial_admin_password | Operations center service initial admin password for the CloudBees CI add-on.          |
+| cbci_liveness_probe_ext     | Operations center service external liveness probe for the CloudBees CI add-on.         |
+| cbci_liveness_probe_int     | Operations center service internal liveness probe for the CloudBees CI add-on.         |
+| cbci_namespace              | Namespace for the CloudBees CI add-on.                                                 |
+| cbci_oc_ing                 | Operations center Ingress for the CloudBees CI add-on.                                 |
+| cbci_oc_pod                 | Operations center pod for the CloudBees CI add-on.                                     |
+| cbci_oc_url                 | URL of the CloudBees CI operations center for the CloudBees CI add-on.                 |
+| eks_cluster_arn             | Amazon EKS cluster ARN.                                                                |
+| eks_cluster_name            | Amazon EKS cluster Name.                                                               |
+| kubeconfig_add              | Add kubeconfig to your local configuration to access the Kubernetes API.               |
+| kubeconfig_export           | Export the KUBECONFIG environment variable to access the Kubernetes API.               |
+| vpc_arn                     | VPC ID.                                                                                |
 <!-- END_TF_DOCS -->
 
 ## Deploy