Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

use term "API" correctly #136

Merged
merged 4 commits into from
Oct 13, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 0 additions & 1 deletion .github/vale/styles/Klaw/branding-warning-temp.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
3 changes: 2 additions & 1 deletion .github/vale/styles/Klaw/branding.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,5 @@ swap:
"type[ -]?scripts?": TypeScript
"(?i)ssl": SSL
"(?<!Klaw )cluster api": Klaw Cluster API
"(?i)kafka[ -]?connect": Kafka Connect
"(?i)kafka[ -]?connect": Kafka Connect
"(?i)api": API
programmiri marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,14 +44,13 @@ 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`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/HowTo/clusterconnectivity/sr-cluster-ssl-protocol.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/HowTo/installation/run-source.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/Releases/release110.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/Releases/release240.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions docs/Releases/release250.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

Expand Down
4 changes: 2 additions & 2 deletions docs/Releases/release251.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

Expand Down