From c0c5af51383819fe171cc765e251fc442e9740d7 Mon Sep 17 00:00:00 2001
From: YumeiWang <yumei.wang@mohawkcollege.ca>
Date: Fri, 6 Oct 2023 22:09:51 -0400
Subject: [PATCH 1/4] use term "API" correctly

Signed-off-by: YumeiWang <yumei.wang@mohawkcollege.ca>
---
 .github/vale/styles/Klaw/branding.yml                       | 3 ++-
 .../clusterconnectivity/aiven-kafka-cluster-ssl-protocol.md | 2 +-
 .../aiven-kafka-connect-cluster-ssl-protocol.md             | 2 +-
 .../aiven-karapace-cluster-ssl-protocol.md                  | 6 +++---
 .../confluent-cloud-kafka-cluster-ssl-protocol.md           | 2 +-
 .../clusterconnectivity/kafka-cluster-sasl-ssl-protocol.md  | 2 +-
 .../HowTo/clusterconnectivity/kafka-cluster-ssl-protocol.md | 2 +-
 docs/HowTo/clusterconnectivity/klaw-core-with-clusterapi.md | 2 +-
 docs/HowTo/clusterconnectivity/sr-cluster-ssl-protocol.md   | 2 +-
 docs/HowTo/installation/run-source.md                       | 4 ++--
 docs/Releases/release110.md                                 | 2 +-
 docs/Releases/release240.md                                 | 2 +-
 docs/Releases/release250.md                                 | 4 ++--
 docs/Releases/release251.md                                 | 4 ++--
 14 files changed, 20 insertions(+), 19 deletions(-)

diff --git a/.github/vale/styles/Klaw/branding.yml b/.github/vale/styles/Klaw/branding.yml
index 8267b865..043c404c 100644
--- a/.github/vale/styles/Klaw/branding.yml
+++ b/.github/vale/styles/Klaw/branding.yml
@@ -24,4 +24,5 @@ swap:
   "type[ -]?scripts?": TypeScript
   "(?i)ssl": SSL
   "(?<!Klaw )cluster api": Klaw Cluster API
-  "(?i)kafka[ -]?connect": Kafka Connect
\ No newline at end of file
+  "(?i)kafka[ -]?connect": Kafka Connect
+  "(?i)api": API
\ No newline at end of file
diff --git a/docs/HowTo/clusterconnectivity/aiven-kafka-cluster-ssl-protocol.md b/docs/HowTo/clusterconnectivity/aiven-kafka-cluster-ssl-protocol.md
index c06ff83d..ed2d9061 100644
--- a/docs/HowTo/clusterconnectivity/aiven-kafka-cluster-ssl-protocol.md
+++ b/docs/HowTo/clusterconnectivity/aiven-kafka-cluster-ssl-protocol.md
@@ -50,7 +50,7 @@ Kafka® and Klaw using SSL protocol:
    icon that is available on the right-hand side of each cluster
    row.
 9. Open the `application.properties` file located in the
-   [klaw/cluster-api/src/main/resources] directory.
+   [klaw/cluster-API/src/main/resources] directory.
 10. Configure the SSL properties to connect to Aiven for Apache Kafka®
     clusters by copying and editing the following lines.
 
diff --git a/docs/HowTo/clusterconnectivity/aiven-kafka-connect-cluster-ssl-protocol.md b/docs/HowTo/clusterconnectivity/aiven-kafka-connect-cluster-ssl-protocol.md
index fd43a265..02f97e14 100644
--- a/docs/HowTo/clusterconnectivity/aiven-kafka-connect-cluster-ssl-protocol.md
+++ b/docs/HowTo/clusterconnectivity/aiven-kafka-connect-cluster-ssl-protocol.md
@@ -52,7 +52,7 @@ Kafka Connect service with Klaw using SSL protocol:
    the copy icon that is available on the right-hand side of each
    cluster row.
 
-8. In the `application.properties` file for [cluster-api] (klaw/cluster-api/src/main/resources) module, configure Aiven for Apache Kafka Connect credentials copied from Aiven console:
+8. In the `application.properties` file for [cluster-API] (klaw/cluster-API/src/main/resources) module, configure Aiven for Apache Kafka Connect credentials copied from Aiven console:
 
    `clusterid.klaw.kafkaconnect.credentials=username:password`
 
diff --git a/docs/HowTo/clusterconnectivity/aiven-karapace-cluster-ssl-protocol.md b/docs/HowTo/clusterconnectivity/aiven-karapace-cluster-ssl-protocol.md
index 4df7b3ff..f6c6fe18 100644
--- a/docs/HowTo/clusterconnectivity/aiven-karapace-cluster-ssl-protocol.md
+++ b/docs/HowTo/clusterconnectivity/aiven-karapace-cluster-ssl-protocol.md
@@ -44,14 +44,14 @@ registry cluster with Klaw using SSL protocol:
 6. In the **Schema Registry Environments** section, click **Add
    Environment** and enter the details to add your schema registry
    environment. Click **Save**.
-7. Open the `application.properties` file for [cluster-api]
-   (klaw/cluster-api/src/main/resources) modules.
+7. Open the `application.properties` file for [cluster-API]
+   (klaw/cluster-API/src/main/resources) modules.
 8. Copy the **Cluster ID** from the **Clusters** page using the copy
    icon that is available on the right-hand side of each cluster
    row.
 
 9. In the `application.properties` file
-   for [cluster-api](https://github.com/aiven/klaw/blob/main/cluster-api/src/main/resources/application.properties)
+   for [cluster-API](https://github.com/aiven/klaw/blob/main/cluster-api/src/main/resources/application.properties)
    module, configure Karapace credentials copied from the Aiven console
 
    `clusterid.klaw.schemaregistry.credentials=username:password`
diff --git a/docs/HowTo/clusterconnectivity/confluent-cloud-kafka-cluster-ssl-protocol.md b/docs/HowTo/clusterconnectivity/confluent-cloud-kafka-cluster-ssl-protocol.md
index 5c5ff992..0a36b418 100644
--- a/docs/HowTo/clusterconnectivity/confluent-cloud-kafka-cluster-ssl-protocol.md
+++ b/docs/HowTo/clusterconnectivity/confluent-cloud-kafka-cluster-ssl-protocol.md
@@ -57,7 +57,7 @@ Follow the steps below to configure and connect to a Confluent Cloud Kafka and K
    icon that is available on the right-hand side of each cluster
    row.
 9. Open the `application.properties` file located in the
-   [klaw/cluster-api/src/main/resources] directory.
+   [klaw/cluster-API/src/main/resources] directory.
 10. Configure the API key, API secret, URIs to connect to Confluent Cloud
     Kafka clusters by copying and editing the following lines:
 
diff --git a/docs/HowTo/clusterconnectivity/kafka-cluster-sasl-ssl-protocol.md b/docs/HowTo/clusterconnectivity/kafka-cluster-sasl-ssl-protocol.md
index 15fcee65..87727aed 100644
--- a/docs/HowTo/clusterconnectivity/kafka-cluster-sasl-ssl-protocol.md
+++ b/docs/HowTo/clusterconnectivity/kafka-cluster-sasl-ssl-protocol.md
@@ -37,7 +37,7 @@ cluster in Klaw using SASL_SSL protocol:
    icon that is available on the right-hand side of each cluster
    row.
 9. Open the `application.properties` file located in the
-   [cluster-api](https://github.com/aiven/klaw/blob/main/cluster-api/src/main/resources) directory.
+   [cluster-API](https://github.com/aiven/klaw/blob/main/cluster-api/src/main/resources) directory.
 10. Depending on your SASL mechanism, copy one of the below
     properties, replace `clusterid` with the copied cluster id, and save
     the `application.properties` file.
diff --git a/docs/HowTo/clusterconnectivity/kafka-cluster-ssl-protocol.md b/docs/HowTo/clusterconnectivity/kafka-cluster-ssl-protocol.md
index 7399e72c..a9256a4d 100644
--- a/docs/HowTo/clusterconnectivity/kafka-cluster-ssl-protocol.md
+++ b/docs/HowTo/clusterconnectivity/kafka-cluster-ssl-protocol.md
@@ -43,7 +43,7 @@ cluster in Klaw using SSL protocol:
    icon that is available on the right-hand side of each cluster
    row.
 9. Open the `application.properties` file located in the
-   [klaw/cluster-api/src/main/resources] directory.
+   [klaw/cluster-API/src/main/resources] directory.
 
 10. Configure the SSL properties to connect to Apache Kafka clusters by copying and editing the following lines:
 
diff --git a/docs/HowTo/clusterconnectivity/klaw-core-with-clusterapi.md b/docs/HowTo/clusterconnectivity/klaw-core-with-clusterapi.md
index f1bf3265..d3550395 100644
--- a/docs/HowTo/clusterconnectivity/klaw-core-with-clusterapi.md
+++ b/docs/HowTo/clusterconnectivity/klaw-core-with-clusterapi.md
@@ -7,7 +7,7 @@ respective `application.properties` files and verifying the connectivity between
 You can find the `application.properties` file located in the following paths:
 
 - Core: [klaw/core/src/main/resources]
-- Cluster-api: [klaw/cluster-api/src/main/resources]
+- Cluster-API: [klaw/cluster-API/src/main/resources]
 
 ## Configure Klaw application.properties file
 
diff --git a/docs/HowTo/clusterconnectivity/sr-cluster-ssl-protocol.md b/docs/HowTo/clusterconnectivity/sr-cluster-ssl-protocol.md
index 60789479..42533901 100644
--- a/docs/HowTo/clusterconnectivity/sr-cluster-ssl-protocol.md
+++ b/docs/HowTo/clusterconnectivity/sr-cluster-ssl-protocol.md
@@ -39,7 +39,7 @@ cluster with Klaw using SSL protocol:
     Environment** and enter the details to add your schema registry
     environment. Click **Save**.
 7.  Open the `application.properties` file for [core](https://github.com/aiven/klaw/tree/main/core)
-    and [cluster-api](https://github.com/aiven/klaw/tree/main/cluster-api) modules.
+    and [cluster-API](https://github.com/aiven/klaw/tree/main/cluster-api) modules.
 
 8.  Copy the **Cluster ID** from the **Clusters** page using the copy
     icon that is available on the right-hand side of each cluster
diff --git a/docs/HowTo/installation/run-source.md b/docs/HowTo/installation/run-source.md
index b3f94042..8f880764 100644
--- a/docs/HowTo/installation/run-source.md
+++ b/docs/HowTo/installation/run-source.md
@@ -28,7 +28,7 @@ the source.
    - Configure the property `klaw.clusterapi.access.base64.secret` in the `application.properties` file with a base64
      string in the module: core.
    - Configure the property `klaw.clusterapi.access.base64.secret` in the `application.properties` file with the above
-     base64 string in the module: cluster-api.
+     base64 string in the module: cluster-API.
 
    ```{.bash caption="Bash Generation Example"}
    echo "ThisIsExactlyA32CharStringSecret" | base64
@@ -42,7 +42,7 @@ the source.
 
 4. Build the project by running `./mvnw clean package` for Linux(bash) or `mvnw clean package` for Windows, from the top
    level of the project directory. This will build JAR files in the `target/` directories of each module: core and
-   cluster-api.
+   cluster-API.
 
    node, npm, and pnpm are also installed locally (required for React UI assets) through maven execution plugins.
 
diff --git a/docs/Releases/release110.md b/docs/Releases/release110.md
index 561101cd..c3a728e3 100644
--- a/docs/Releases/release110.md
+++ b/docs/Releases/release110.md
@@ -18,7 +18,7 @@ improvements.
   connect to Apache Kafka clusters.
 - Enabled JWT-based authentication: Enabled JWT-based authentication
   to connect to Klaw Cluster API. You can configure
-  klaw.clusterapi.access.base64.secret in both core and cluster-api
+  klaw.clusterapi.access.base64.secret in both core and cluster-API
   modules to enable this authentication between APIs.
 - Connect to multiple clusters using SSL: This release includes the
   functionality to configure Klaw to connect to multiple Apache Kafka
diff --git a/docs/Releases/release240.md b/docs/Releases/release240.md
index 28d02d8b..48c879d1 100644
--- a/docs/Releases/release240.md
+++ b/docs/Releases/release240.md
@@ -18,7 +18,7 @@ schemas from schema registry to Klaw, and vice versa.
 
 [klaw-2.4.0.jar ⬇︎](https://github.com/Aiven-Open/klaw/releases/download/v2.4.0/klaw-2.4.0.jar)
 
-[cluster-api-2.4.0.jar ⬇](https://github.com/Aiven-Open/klaw/releases/download/v2.4.0/cluster-api-2.4.0.jar)
+[cluster-API-2.4.0.jar ⬇](https://github.com/Aiven-Open/klaw/releases/download/v2.4.0/cluster-api-2.4.0.jar)
 
 ### Sources
 
diff --git a/docs/Releases/release250.md b/docs/Releases/release250.md
index f4cc7da0..7c33a0a0 100644
--- a/docs/Releases/release250.md
+++ b/docs/Releases/release250.md
@@ -18,7 +18,7 @@ schemas from schema registry to Klaw, and vice versa.
 
 [klaw-2.5.0.jar ⬇︎](https://github.com/Aiven-Open/klaw/releases/download/v2.5.0/klaw-2.5.0.jar)
 
-[cluster-api-2.5.0.jar ⬇](https://github.com/Aiven-Open/klaw/releases/download/v2.5.0/cluster-api-2.5.0.jar)
+[cluster-API-2.5.0.jar ⬇](https://github.com/Aiven-Open/klaw/releases/download/v2.5.0/cluster-api-2.5.0.jar)
 
 ### Sources
 
@@ -27,7 +27,7 @@ schemas from schema registry to Klaw, and vice versa.
 ### Docker
 
 [Klaw-core](https://hub.docker.com/r/aivenoy/klaw-core)
-[Klaw-cluster-api](https://hub.docker.com/r/aivenoy/klaw-cluster-api)
+[Klaw-cluster-API](https://hub.docker.com/r/aivenoy/klaw-cluster-api)
 
 ## What's new in Klaw 2.5.0
 
diff --git a/docs/Releases/release251.md b/docs/Releases/release251.md
index eca65e7c..f8dda35b 100644
--- a/docs/Releases/release251.md
+++ b/docs/Releases/release251.md
@@ -16,7 +16,7 @@ Klaw version 2.5.1 is a patch release primarily aimed at enhancing MySQL support
 
 - [klaw-2.5.1.jar ⬇︎](https://github.com/Aiven-Open/klaw/releases/download/v2.5.1/klaw-2.5.1.jar)
 
-- [cluster-api-2.5.1.jar ⬇](https://github.com/Aiven-Open/klaw/releases/download/v2.5.1/cluster-api-2.5.1.jar)
+- [cluster-API-2.5.1.jar ⬇](https://github.com/Aiven-Open/klaw/releases/download/v2.5.1/cluster-api-2.5.1.jar)
 
 ### Sources
 
@@ -25,7 +25,7 @@ Klaw version 2.5.1 is a patch release primarily aimed at enhancing MySQL support
 ### Docker
 
 - [Klaw-core](https://hub.docker.com/r/aivenoy/klaw-core)
-- [Klaw-cluster-api](https://hub.docker.com/r/aivenoy/klaw-cluster-api)
+- [Klaw-cluster-API](https://hub.docker.com/r/aivenoy/klaw-cluster-api)
 
 ## What's new in Klaw 2.5.1
 

From e8f60644de6762a049a79bdad16a495774d63243 Mon Sep 17 00:00:00 2001
From: YumeiWang <yumei.wang@mohawkcollege.ca>
Date: Tue, 10 Oct 2023 09:58:34 -0400
Subject: [PATCH 2/4] revise according to the review

Signed-off-by: YumeiWang <yumei.wang@mohawkcollege.ca>
---
 .github/vale/styles/Klaw/branding-warning-temp.yml          | 1 -
 .github/vale/styles/Klaw/branding.yml                       | 3 +--
 .../clusterconnectivity/aiven-kafka-cluster-ssl-protocol.md | 2 +-
 .../aiven-kafka-connect-cluster-ssl-protocol.md             | 2 +-
 .../aiven-karapace-cluster-ssl-protocol.md                  | 6 +++---
 .../confluent-cloud-kafka-cluster-ssl-protocol.md           | 2 +-
 .../clusterconnectivity/kafka-cluster-sasl-ssl-protocol.md  | 2 +-
 .../HowTo/clusterconnectivity/kafka-cluster-ssl-protocol.md | 2 +-
 docs/HowTo/clusterconnectivity/klaw-core-with-clusterapi.md | 2 +-
 docs/HowTo/clusterconnectivity/sr-cluster-ssl-protocol.md   | 2 +-
 docs/HowTo/installation/run-source.md                       | 4 ++--
 docs/Releases/release110.md                                 | 2 +-
 docs/Releases/release250.md                                 | 2 +-
 docs/Releases/release251.md                                 | 2 +-
 14 files changed, 16 insertions(+), 18 deletions(-)

diff --git a/.github/vale/styles/Klaw/branding-warning-temp.yml b/.github/vale/styles/Klaw/branding-warning-temp.yml
index 96f42708..2e1808b2 100644
--- a/.github/vale/styles/Klaw/branding-warning-temp.yml
+++ b/.github/vale/styles/Klaw/branding-warning-temp.yml
@@ -6,6 +6,5 @@ ignorecase: true
 # Vale will ignore any alerts that match the intended form.
 swap:
   "(?<!Apache )kafka": Apache Kafka
-  "(?i)api": API
   "(?i)klaw core": Klaw Core
   "(?i)klaw": Klaw
\ No newline at end of file
diff --git a/.github/vale/styles/Klaw/branding.yml b/.github/vale/styles/Klaw/branding.yml
index 043c404c..8267b865 100644
--- a/.github/vale/styles/Klaw/branding.yml
+++ b/.github/vale/styles/Klaw/branding.yml
@@ -24,5 +24,4 @@ swap:
   "type[ -]?scripts?": TypeScript
   "(?i)ssl": SSL
   "(?<!Klaw )cluster api": Klaw Cluster API
-  "(?i)kafka[ -]?connect": Kafka Connect
-  "(?i)api": API
\ No newline at end of file
+  "(?i)kafka[ -]?connect": Kafka Connect
\ No newline at end of file
diff --git a/docs/HowTo/clusterconnectivity/aiven-kafka-cluster-ssl-protocol.md b/docs/HowTo/clusterconnectivity/aiven-kafka-cluster-ssl-protocol.md
index ed2d9061..fc672c02 100644
--- a/docs/HowTo/clusterconnectivity/aiven-kafka-cluster-ssl-protocol.md
+++ b/docs/HowTo/clusterconnectivity/aiven-kafka-cluster-ssl-protocol.md
@@ -50,7 +50,7 @@ Kafka® and Klaw using SSL protocol:
    icon that is available on the right-hand side of each cluster
    row.
 9. Open the `application.properties` file located in the
-   [klaw/cluster-API/src/main/resources] directory.
+   `klaw/cluster-api/src/main/resources` directory.
 10. Configure the SSL properties to connect to Aiven for Apache Kafka®
     clusters by copying and editing the following lines.
 
diff --git a/docs/HowTo/clusterconnectivity/aiven-kafka-connect-cluster-ssl-protocol.md b/docs/HowTo/clusterconnectivity/aiven-kafka-connect-cluster-ssl-protocol.md
index 02f97e14..2e6b4023 100644
--- a/docs/HowTo/clusterconnectivity/aiven-kafka-connect-cluster-ssl-protocol.md
+++ b/docs/HowTo/clusterconnectivity/aiven-kafka-connect-cluster-ssl-protocol.md
@@ -52,7 +52,7 @@ Kafka Connect service with Klaw using SSL protocol:
    the copy icon that is available on the right-hand side of each
    cluster row.
 
-8. In the `application.properties` file for [cluster-API] (klaw/cluster-API/src/main/resources) module, configure Aiven for Apache Kafka Connect credentials copied from Aiven console:
+8. In the `application.properties` file for [cluster-API] (klaw/cluster-api/src/main/resources) module, configure Aiven for Apache Kafka Connect credentials copied from Aiven console:
 
    `clusterid.klaw.kafkaconnect.credentials=username:password`
 
diff --git a/docs/HowTo/clusterconnectivity/aiven-karapace-cluster-ssl-protocol.md b/docs/HowTo/clusterconnectivity/aiven-karapace-cluster-ssl-protocol.md
index f6c6fe18..f828fa87 100644
--- a/docs/HowTo/clusterconnectivity/aiven-karapace-cluster-ssl-protocol.md
+++ b/docs/HowTo/clusterconnectivity/aiven-karapace-cluster-ssl-protocol.md
@@ -44,14 +44,14 @@ registry cluster with Klaw using SSL protocol:
 6. In the **Schema Registry Environments** section, click **Add
    Environment** and enter the details to add your schema registry
    environment. Click **Save**.
-7. Open the `application.properties` file for [cluster-API]
-   (klaw/cluster-API/src/main/resources) modules.
+7. Open the `application.properties` file for [`cluster-api`]
+   (klaw/cluster-api/src/main/resources) modules.
 8. Copy the **Cluster ID** from the **Clusters** page using the copy
    icon that is available on the right-hand side of each cluster
    row.
 
 9. In the `application.properties` file
-   for [cluster-API](https://github.com/aiven/klaw/blob/main/cluster-api/src/main/resources/application.properties)
+   for [`cluster-api`](https://github.com/aiven/klaw/blob/main/cluster-api/src/main/resources/application.properties)
    module, configure Karapace credentials copied from the Aiven console
 
    `clusterid.klaw.schemaregistry.credentials=username:password`
diff --git a/docs/HowTo/clusterconnectivity/confluent-cloud-kafka-cluster-ssl-protocol.md b/docs/HowTo/clusterconnectivity/confluent-cloud-kafka-cluster-ssl-protocol.md
index 0a36b418..88cc5273 100644
--- a/docs/HowTo/clusterconnectivity/confluent-cloud-kafka-cluster-ssl-protocol.md
+++ b/docs/HowTo/clusterconnectivity/confluent-cloud-kafka-cluster-ssl-protocol.md
@@ -57,7 +57,7 @@ Follow the steps below to configure and connect to a Confluent Cloud Kafka and K
    icon that is available on the right-hand side of each cluster
    row.
 9. Open the `application.properties` file located in the
-   [klaw/cluster-API/src/main/resources] directory.
+   `klaw/cluster-api/src/main/resources` directory.
 10. Configure the API key, API secret, URIs to connect to Confluent Cloud
     Kafka clusters by copying and editing the following lines:
 
diff --git a/docs/HowTo/clusterconnectivity/kafka-cluster-sasl-ssl-protocol.md b/docs/HowTo/clusterconnectivity/kafka-cluster-sasl-ssl-protocol.md
index 87727aed..8bbba8fd 100644
--- a/docs/HowTo/clusterconnectivity/kafka-cluster-sasl-ssl-protocol.md
+++ b/docs/HowTo/clusterconnectivity/kafka-cluster-sasl-ssl-protocol.md
@@ -37,7 +37,7 @@ cluster in Klaw using SASL_SSL protocol:
    icon that is available on the right-hand side of each cluster
    row.
 9. Open the `application.properties` file located in the
-   [cluster-API](https://github.com/aiven/klaw/blob/main/cluster-api/src/main/resources) directory.
+   [`cluster-api`](https://github.com/aiven/klaw/blob/main/cluster-api/src/main/resources) directory.
 10. Depending on your SASL mechanism, copy one of the below
     properties, replace `clusterid` with the copied cluster id, and save
     the `application.properties` file.
diff --git a/docs/HowTo/clusterconnectivity/kafka-cluster-ssl-protocol.md b/docs/HowTo/clusterconnectivity/kafka-cluster-ssl-protocol.md
index a9256a4d..31ab4d1d 100644
--- a/docs/HowTo/clusterconnectivity/kafka-cluster-ssl-protocol.md
+++ b/docs/HowTo/clusterconnectivity/kafka-cluster-ssl-protocol.md
@@ -43,7 +43,7 @@ cluster in Klaw using SSL protocol:
    icon that is available on the right-hand side of each cluster
    row.
 9. Open the `application.properties` file located in the
-   [klaw/cluster-API/src/main/resources] directory.
+   `klaw/cluster-api/src/main/resources` directory.
 
 10. Configure the SSL properties to connect to Apache Kafka clusters by copying and editing the following lines:
 
diff --git a/docs/HowTo/clusterconnectivity/klaw-core-with-clusterapi.md b/docs/HowTo/clusterconnectivity/klaw-core-with-clusterapi.md
index d3550395..03d3faa2 100644
--- a/docs/HowTo/clusterconnectivity/klaw-core-with-clusterapi.md
+++ b/docs/HowTo/clusterconnectivity/klaw-core-with-clusterapi.md
@@ -7,7 +7,7 @@ respective `application.properties` files and verifying the connectivity between
 You can find the `application.properties` file located in the following paths:
 
 - Core: [klaw/core/src/main/resources]
-- Cluster-API: [klaw/cluster-API/src/main/resources]
+- Cluster-API: `klaw/cluster-api/src/main/resources`
 
 ## Configure Klaw application.properties file
 
diff --git a/docs/HowTo/clusterconnectivity/sr-cluster-ssl-protocol.md b/docs/HowTo/clusterconnectivity/sr-cluster-ssl-protocol.md
index 42533901..7e4589e6 100644
--- a/docs/HowTo/clusterconnectivity/sr-cluster-ssl-protocol.md
+++ b/docs/HowTo/clusterconnectivity/sr-cluster-ssl-protocol.md
@@ -39,7 +39,7 @@ cluster with Klaw using SSL protocol:
     Environment** and enter the details to add your schema registry
     environment. Click **Save**.
 7.  Open the `application.properties` file for [core](https://github.com/aiven/klaw/tree/main/core)
-    and [cluster-API](https://github.com/aiven/klaw/tree/main/cluster-api) modules.
+    and [`cluster-api`](https://github.com/aiven/klaw/tree/main/cluster-api) modules.
 
 8.  Copy the **Cluster ID** from the **Clusters** page using the copy
     icon that is available on the right-hand side of each cluster
diff --git a/docs/HowTo/installation/run-source.md b/docs/HowTo/installation/run-source.md
index 8f880764..365d07a8 100644
--- a/docs/HowTo/installation/run-source.md
+++ b/docs/HowTo/installation/run-source.md
@@ -28,7 +28,7 @@ the source.
    - Configure the property `klaw.clusterapi.access.base64.secret` in the `application.properties` file with a base64
      string in the module: core.
    - Configure the property `klaw.clusterapi.access.base64.secret` in the `application.properties` file with the above
-     base64 string in the module: cluster-API.
+     base64 string in the module: `cluster-api`.
 
    ```{.bash caption="Bash Generation Example"}
    echo "ThisIsExactlyA32CharStringSecret" | base64
@@ -42,7 +42,7 @@ the source.
 
 4. Build the project by running `./mvnw clean package` for Linux(bash) or `mvnw clean package` for Windows, from the top
    level of the project directory. This will build JAR files in the `target/` directories of each module: core and
-   cluster-API.
+   `cluster-api`.
 
    node, npm, and pnpm are also installed locally (required for React UI assets) through maven execution plugins.
 
diff --git a/docs/Releases/release110.md b/docs/Releases/release110.md
index c3a728e3..64e11a56 100644
--- a/docs/Releases/release110.md
+++ b/docs/Releases/release110.md
@@ -18,7 +18,7 @@ improvements.
   connect to Apache Kafka clusters.
 - Enabled JWT-based authentication: Enabled JWT-based authentication
   to connect to Klaw Cluster API. You can configure
-  klaw.clusterapi.access.base64.secret in both core and cluster-API
+  klaw.clusterapi.access.base64.secret in both core and Cluster API
   modules to enable this authentication between APIs.
 - Connect to multiple clusters using SSL: This release includes the
   functionality to configure Klaw to connect to multiple Apache Kafka
diff --git a/docs/Releases/release250.md b/docs/Releases/release250.md
index 7c33a0a0..454c4c1f 100644
--- a/docs/Releases/release250.md
+++ b/docs/Releases/release250.md
@@ -18,7 +18,7 @@ schemas from schema registry to Klaw, and vice versa.
 
 [klaw-2.5.0.jar ⬇︎](https://github.com/Aiven-Open/klaw/releases/download/v2.5.0/klaw-2.5.0.jar)
 
-[cluster-API-2.5.0.jar ⬇](https://github.com/Aiven-Open/klaw/releases/download/v2.5.0/cluster-api-2.5.0.jar)
+[`cluster-api-2.5.0.jar` ⬇](https://github.com/Aiven-Open/klaw/releases/download/v2.5.0/cluster-api-2.5.0.jar)
 
 ### Sources
 
diff --git a/docs/Releases/release251.md b/docs/Releases/release251.md
index f8dda35b..cf6709fc 100644
--- a/docs/Releases/release251.md
+++ b/docs/Releases/release251.md
@@ -16,7 +16,7 @@ Klaw version 2.5.1 is a patch release primarily aimed at enhancing MySQL support
 
 - [klaw-2.5.1.jar ⬇︎](https://github.com/Aiven-Open/klaw/releases/download/v2.5.1/klaw-2.5.1.jar)
 
-- [cluster-API-2.5.1.jar ⬇](https://github.com/Aiven-Open/klaw/releases/download/v2.5.1/cluster-api-2.5.1.jar)
+- [`cluster-api-2.5.1.jar` ⬇](https://github.com/Aiven-Open/klaw/releases/download/v2.5.1/cluster-api-2.5.1.jar)
 
 ### Sources
 

From babe4cdb9176696fe54092f995f83b1ffe0b1bed Mon Sep 17 00:00:00 2001
From: YumeiWang <yumei.wang@mohawkcollege.ca>
Date: Wed, 11 Oct 2023 10:46:08 -0400
Subject: [PATCH 3/4] format

Signed-off-by: YumeiWang <yumei.wang@mohawkcollege.ca>
---
 .github/vale/styles/Klaw/branding.yml | 3 ++-
 docs/Releases/release240.md           | 2 +-
 2 files changed, 3 insertions(+), 2 deletions(-)

diff --git a/.github/vale/styles/Klaw/branding.yml b/.github/vale/styles/Klaw/branding.yml
index 8267b865..043c404c 100644
--- a/.github/vale/styles/Klaw/branding.yml
+++ b/.github/vale/styles/Klaw/branding.yml
@@ -24,4 +24,5 @@ swap:
   "type[ -]?scripts?": TypeScript
   "(?i)ssl": SSL
   "(?<!Klaw )cluster api": Klaw Cluster API
-  "(?i)kafka[ -]?connect": Kafka Connect
\ No newline at end of file
+  "(?i)kafka[ -]?connect": Kafka Connect
+  "(?i)api": API
\ No newline at end of file
diff --git a/docs/Releases/release240.md b/docs/Releases/release240.md
index 48c879d1..516e65c2 100644
--- a/docs/Releases/release240.md
+++ b/docs/Releases/release240.md
@@ -18,7 +18,7 @@ schemas from schema registry to Klaw, and vice versa.
 
 [klaw-2.4.0.jar ⬇︎](https://github.com/Aiven-Open/klaw/releases/download/v2.4.0/klaw-2.4.0.jar)
 
-[cluster-API-2.4.0.jar ⬇](https://github.com/Aiven-Open/klaw/releases/download/v2.4.0/cluster-api-2.4.0.jar)
+[`cluster-api-2.4.0.jar` ⬇](https://github.com/Aiven-Open/klaw/releases/download/v2.4.0/cluster-api-2.4.0.jar)
 
 ### Sources
 

From 76f676d4bb7409b510020e0a6892f1c81ac73aaa Mon Sep 17 00:00:00 2001
From: YumeiWang <yumei.wang@mohawkcollege.ca>
Date: Thu, 12 Oct 2023 15:27:03 -0400
Subject: [PATCH 4/4] fix  github checks

Signed-off-by: YumeiWang <yumei.wang@mohawkcollege.ca>
---
 .../aiven-kafka-connect-cluster-ssl-protocol.md                | 2 +-
 .../clusterconnectivity/aiven-karapace-cluster-ssl-protocol.md | 3 +--
 docs/Releases/release110.md                                    | 2 +-
 3 files changed, 3 insertions(+), 4 deletions(-)

diff --git a/docs/HowTo/clusterconnectivity/aiven-kafka-connect-cluster-ssl-protocol.md b/docs/HowTo/clusterconnectivity/aiven-kafka-connect-cluster-ssl-protocol.md
index 2e6b4023..424a02a1 100644
--- a/docs/HowTo/clusterconnectivity/aiven-kafka-connect-cluster-ssl-protocol.md
+++ b/docs/HowTo/clusterconnectivity/aiven-kafka-connect-cluster-ssl-protocol.md
@@ -52,7 +52,7 @@ Kafka Connect service with Klaw using SSL protocol:
    the copy icon that is available on the right-hand side of each
    cluster row.
 
-8. In the `application.properties` file for [cluster-API] (klaw/cluster-api/src/main/resources) module, configure Aiven for Apache Kafka Connect credentials copied from Aiven console:
+8. In the `application.properties` file for [`cluster-api`](klaw/cluster-api/src/main/resources) module, configure Aiven for Apache Kafka Connect credentials copied from Aiven console:
 
    `clusterid.klaw.kafkaconnect.credentials=username:password`
 
diff --git a/docs/HowTo/clusterconnectivity/aiven-karapace-cluster-ssl-protocol.md b/docs/HowTo/clusterconnectivity/aiven-karapace-cluster-ssl-protocol.md
index f828fa87..a38cbcb3 100644
--- a/docs/HowTo/clusterconnectivity/aiven-karapace-cluster-ssl-protocol.md
+++ b/docs/HowTo/clusterconnectivity/aiven-karapace-cluster-ssl-protocol.md
@@ -44,8 +44,7 @@ registry cluster with Klaw using SSL protocol:
 6. In the **Schema Registry Environments** section, click **Add
    Environment** and enter the details to add your schema registry
    environment. Click **Save**.
-7. Open the `application.properties` file for [`cluster-api`]
-   (klaw/cluster-api/src/main/resources) modules.
+7. Open the `application.properties` file for [`cluster-api`](klaw/cluster-api/src/main/resources) modules.
 8. Copy the **Cluster ID** from the **Clusters** page using the copy
    icon that is available on the right-hand side of each cluster
    row.
diff --git a/docs/Releases/release110.md b/docs/Releases/release110.md
index 64e11a56..0e5ce761 100644
--- a/docs/Releases/release110.md
+++ b/docs/Releases/release110.md
@@ -18,7 +18,7 @@ improvements.
   connect to Apache Kafka clusters.
 - Enabled JWT-based authentication: Enabled JWT-based authentication
   to connect to Klaw Cluster API. You can configure
-  klaw.clusterapi.access.base64.secret in both core and Cluster API
+  klaw.clusterapi.access.base64.secret in both core and Klaw Cluster API
   modules to enable this authentication between APIs.
 - Connect to multiple clusters using SSL: This release includes the
   functionality to configure Klaw to connect to multiple Apache Kafka