From 76cf4b52fb7e4692e35b4a12d807815ec26dad85 Mon Sep 17 00:00:00 2001 From: Lorenzo Nicora Date: Wed, 2 Jul 2025 11:58:39 +0100 Subject: [PATCH] Fix top README --- CONTRIBUTING.md | 18 ++++++++++++++---- README.md | 12 ++---------- 2 files changed, 16 insertions(+), 14 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b2ce7d9..361a68d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -59,6 +59,7 @@ The AWS team managing the repository reserves the right to modify or reject new versions, external dependencies, permissions, and runtime configuration. Use [this example](https://github.com/aws-samples/amazon-managed-service-for-apache-flink-examples/tree/main/java/KafkaConfigProviders/Kafka-SASL_SSL-ConfigProviders) as a reference. * Make sure the example works with what explained in the README, and without any implicit dependency or configuration. +* Add an entry for the new example in the top-level [README](README.md) or in the README of the subfolder, if the example is in a subfolder such as `java/FlinkCDC` or `java/Iceberg` #### AWS authentication and credentials @@ -66,10 +67,19 @@ The AWS team managing the repository reserves the right to modify or reject new * Any permissions must be provided from the IAM Role assigned to the Managed Apache Flink application. When running locally, leverage the IDE AWS plugins. #### Dependencies in PyFlink examples - * Use the pattern illustrated by [this example](https://github.com/aws-samples/amazon-managed-service-for-apache-flink-examples/tree/main/python/GettingStarted) - to provide JAR dependencies and build the ZIP using Maven. - * If the application also requires Python dependencies, use the pattern illustrated by [this example](https://github.com/aws-samples/amazon-managed-service-for-apache-flink-examples/tree/main/python/PythonDependencies) - leveraging `requirements.txt`. + +* Use the pattern illustrated by [this example](https://github.com/aws-samples/amazon-managed-service-for-apache-flink-examples/tree/main/python/GettingStarted) + to provide JAR dependencies and build the ZIP using Maven. +* If the application also requires Python dependencies used for UDF and data processing in general, use the pattern illustrated by [this example](https://github.com/aws-samples/amazon-managed-service-for-apache-flink-examples/tree/main/python/PythonDependencies) + leveraging `requirements.txt`. +* Only if the application requires Python dependencies used during the job initialization, in the main(), use the pattern + illustrated in [this other example](https://github.com/aws-samples/amazon-managed-service-for-apache-flink-examples/tree/main/python/PackagedPythonDependencies), + packaging dependencies in the ZIP artifact. + +#### Top POM-file for Java examples + +* Add the new Java example also to the `pom.xml` file in the `java/` folder + ## Reporting Bugs/Feature Requests diff --git a/README.md b/README.md index 64807ea..39ad86a 100644 --- a/README.md +++ b/README.md @@ -82,17 +82,9 @@ Example applications in Java, Python, Scala and SQL for Amazon Managed Service f --- -## Security +## Contributing -See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information. - -## License Summary - -This sample code is made available under the MIT-0 license. See the LICENSE file. - -## Security - -See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information. +See [Contributing Guidelines](CONTRIBUTING.md#security-issue-notifications) for more information. ## License Summary