xintongsong commented on code in PR #467: URL: https://github.com/apache/flink-agents/pull/467#discussion_r2719821614
########## docs/content/docs/get-started/installation.md: ########## @@ -151,6 +151,70 @@ After building: - The Python package is installed and ready to use - The distribution JAR is located at: `dist/target/flink-agents-dist-*.jar` +## Maven Dependencies (For Java) + +For developing Flink Agents applications in Java, add the following dependencies to your `pom.xml`: + +### Basic Dependencies for Agent Development + +**Required for developing Agent applications:** +- `flink-agents-api` - Core API for Flink-Agents +- `flink-streaming-java` and `flink-table-api-java` - Core API for Flink + +**Additional dependencies for running in IDE:** +- `flink-agents-ide-support` - Runtime execution dependencies (required for local execution/testing). + Review Comment: Let's use "required" vs. "optional" here. We should explain that, unlike running in a Flink cluster, when running in IDE, runtime dependencies are absent, so we need this additional dependency, and use "run with provided dependencies" feature of IDE. And we should emphasis to use provided scope. ########## ide-support/pom.xml: ########## @@ -0,0 +1,189 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + http://www.apache.org/licenses/LICENSE-2.0 +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +--> +<project xmlns="http://maven.apache.org/POM/4.0.0"; + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd";> + <modelVersion>4.0.0</modelVersion> + <parent> + <groupId>org.apache.flink</groupId> + <artifactId>flink-agents</artifactId> + <version>0.2-SNAPSHOT</version> + </parent> + + <artifactId>flink-agents-ide-support</artifactId> + <name>Flink Agents : IDE Support</name> Review Comment: Let's add a <description> here to explain what this artifact is for. Otherwise, it's a bit implicit. ########## docs/content/docs/get-started/installation.md: ########## @@ -151,6 +151,70 @@ After building: - The Python package is installed and ready to use - The distribution JAR is located at: `dist/target/flink-agents-dist-*.jar` +## Maven Dependencies (For Java) + +For developing Flink Agents applications in Java, add the following dependencies to your `pom.xml`: + +### Basic Dependencies for Agent Development + +**Required for developing Agent applications:** +- `flink-agents-api` - Core API for Flink-Agents +- `flink-streaming-java` and `flink-table-api-java` - Core API for Flink Review Comment: ```suggestion - `flink-streaming-java` and/or `flink-table-api-java` - Core API for Flink ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
