Skip to content

Commit ac6934c

Browse files
authored
Fix top README (#127)
1 parent 4b41e9f commit ac6934c

File tree

2 files changed

+16
-14
lines changed

2 files changed

+16
-14
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,17 +59,27 @@ The AWS team managing the repository reserves the right to modify or reject new
5959
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)
6060
as a reference.
6161
* Make sure the example works with what explained in the README, and without any implicit dependency or configuration.
62+
* 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`
6263

6364
#### AWS authentication and credentials
6465

6566
* AWS credentials must never be explicitly passed to the application.
6667
* Any permissions must be provided from the IAM Role assigned to the Managed Apache Flink application. When running locally, leverage the IDE AWS plugins.
6768

6869
#### Dependencies in PyFlink examples
69-
* Use the pattern illustrated by [this example](https://github.com/aws-samples/amazon-managed-service-for-apache-flink-examples/tree/main/python/GettingStarted)
70-
to provide JAR dependencies and build the ZIP using Maven.
71-
* 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)
72-
leveraging `requirements.txt`.
70+
71+
* Use the pattern illustrated by [this example](https://github.com/aws-samples/amazon-managed-service-for-apache-flink-examples/tree/main/python/GettingStarted)
72+
to provide JAR dependencies and build the ZIP using Maven.
73+
* 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)
74+
leveraging `requirements.txt`.
75+
* Only if the application requires Python dependencies used during the job initialization, in the main(), use the pattern
76+
illustrated in [this other example](https://github.com/aws-samples/amazon-managed-service-for-apache-flink-examples/tree/main/python/PackagedPythonDependencies),
77+
packaging dependencies in the ZIP artifact.
78+
79+
#### Top POM-file for Java examples
80+
81+
* Add the new Java example also to the `pom.xml` file in the `java/` folder
82+
7383

7484
## Reporting Bugs/Feature Requests
7585

README.md

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -82,17 +82,9 @@ Example applications in Java, Python, Scala and SQL for Amazon Managed Service f
8282

8383
---
8484

85-
## Security
85+
## Contributing
8686

87-
See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
88-
89-
## License Summary
90-
91-
This sample code is made available under the MIT-0 license. See the LICENSE file.
92-
93-
## Security
94-
95-
See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
87+
See [Contributing Guidelines](CONTRIBUTING.md#security-issue-notifications) for more information.
9688

9789
## License Summary
9890

0 commit comments

Comments
 (0)