chore: updated README.md

README.md

@@ -0,0 +1,19 @@
+[![Main and pull request checks](https://github.com/Aiven-Open/commons-for-apache-kafka-connect/actions/workflows/main_push_workflow.yml/badge.svg)](https://github.com/Aiven-Open/commons-for-apache-kafka-connect/actions/workflows/main_push_workflow.yml)
+
+# Aiven's Apache Kafka Connectors
+
+- [Aiven Connector Commons](../commons/README.md)
+- [Aiven GCS Connector](../gcs-connector/README.md)
+- [Aiven S3 Connector](../s3-connector/README.md)
+
+# Development
+
+This is a combined repository for Aiven Apache Kafka Connectors.
+
+# License
+
+This project is licensed under the [Apache License, Version 2.0](LICENSE).
+
+# Trademarks
+
+Apache Kafka, Apache Kafka Connect and Apache Maven are either registered trademarks or trademarks of the Apache Software Foundation in the United States and/or other countries.

commons/README.md

@@ -1,18 +1,16 @@
-[![Main and pull request checks](https://github.com/Aiven-Open/commons-for-apache-kafka-connect/actions/workflows/main_push_workflow.yml/badge.svg)](https://github.com/Aiven-Open/commons-for-apache-kafka-connect/actions/workflows/main_push_workflow.yml)
-
 # Aiven's Common Module for Apache Kafka® connectors
 
 Shared common functionality among Aiven's connectors for Apache Kafka:
-- [Aiven GCS Connector](https://github.com/aiven-open/gcs-connector-for-apache-kafka)
-- [Aiven S3 Connector](https://github.com/aiven-open/s3-connector-for-apache-kafka)
+- [Aiven GCS Connector](../gcs-connector/README.md)
+- [Aiven S3 Connector](../s3-connector/README.md)
 
 # Usage
 
 When installing this library on Kafka Connect, use a specific plugin path, and **avoid placing them on the same path as the Kafka Connect binaries**, as some libraries may have conflicting versions.
 
 # Development
 
-To use this library for development, you need to build and publish it in your local Maven repository using command:
+     To use this library for development, you need to build and publish it in your local Maven repository using command:
 <br/>
 `./gradlew clean build publishToMavenLocal`
 

gcs-connector/README.md

@@ -1,7 +1,5 @@
 # Aiven's GCS Sink Connector for Apache Kafka®
 
-![Pull Request Workflow](https://github.com/aiven/gcs-connector-for-apache-kafka/workflows/Pull%20Request%20Workflow/badge.svg)
-
 This is a sink
 [Apache Kafka Connect](https://kafka.apache.org/documentation/#connect)
 connector that stores Kafka messages in a
@@ -649,19 +647,7 @@ Release JARs are available in Maven Central:
 
 ### Developing together with Common Module for Apache Kafka Connect library
 
-This project depends on [Common Module for Apache Kafka Connect](https://github.com/aiven/commons-for-apache-kafka-connect). Normally, an artifact from a globally accessible repository is used. However, if you need to introduce changes to both this connector and Common Module for Apache Kafka Connect library at the same time, you should short-circuit the development loop via locally published artifacts. Please follow these steps:
-1. Checkout the `main` `HEAD` of Common Module for Apache Kafka Connect.
-2. Ensure the version [here](https://github.com/aiven/commons-for-apache-kafka-connect/blob/main/gradle.properties) is with `-SNAPSHOT` prefix.
-3. Make changes to Common Module for Apache Kafka Connect.
-4. Publish it locally with `./gradlew publishToMavenLocal`.
-5. Change the version in the connector's [`build.gradle`](build.gradle.kts) (`ext.aivenConnectCommonsVersion`) to match the published snapshot version of Common Module for Apache Kafka Connect.
-
-After that, the latest changes you've done to Common Module for Apache Kafka Connect will be used.
-
-When you finish developing the feature and is sure Common Module for Apacha Kafka Connect won't need to change:
-1. Make a proper release of Common Module for Apache Kafka Connect.
-2. Publish the artifact to the currently used globally accessible repository.
-3. Change the version of Common Module for Apache Kafka Connect in the connector to the published one.
+This project depends on [Common Module for Apache Kafka Connect](../commons/README.md).
 
 ### Integration testing
 

s3-connector/README.md

@@ -1,7 +1,5 @@
 # Aiven's S3 Sink Connector for Apache Kafka
 
-![Pull Request Workflow](https://github.com/Aiven-Open/s3-connector-for-apache-kafka/actions/workflows/main_push_and_pull_request_workflow.yml/badge.svg)
-
 This is a sink Apache Kafka Connect connector that stores Apache Kafka messages in an AWS S3 bucket.
 
 **Table of Contents**
@@ -619,19 +617,7 @@ There are four configuration properties to configure retry strategy exists.
 
 ### Developing together with Commons library
 
-This project depends on [Common Module for Apache Kafka Connect](https://github.com/aiven-open/commons-for-apache-kafka-connect). Normally, an artifact of it published to a globally accessible repository is used. However, if you need to introduce changes to both this connector and Commons library at the same time, you should short-circuit the development loop via locally published artifacts. Please follow this steps:
-1. Checkout the `main` `HEAD` of Commons.
-2. Ensure the version [here](https://github.com/aiven-open/commons-for-apache-kafka-connect/blob/main/gradle.properties) is with `-SNAPSHOT` prefix.
-3. Make changes to Commons.
-4. Publish it locally with `./gradlew publishToMavenLocal`.
-5. Change the version in the connector's [`build.gradle`](build.gradle.kts) (`ext.aivenConnectCommonsVersion`) to match the published snapshot version of Commons.
-
-After that, the latest changes you've done to Commons will be used.
-
-When you finish developing the feature and is sure Commons won't need to change:
-1. Make a proper release of Commons.
-2. Publish the artifact to the currently used globally accessible repository.
-3. Change the version of Commons in the connector to the published one.
+This project depends on [Common Module for Apache Kafka Connect](../commons/README.md).
 
 ### Integration testing