xintongsong commented on code in PR #226:
URL: https://github.com/apache/flink-agents/pull/226#discussion_r2387916654
##########
docs/content/docs/get-started/installation.md:
##########
@@ -22,47 +22,46 @@ specific language governing permissions and limitations
under the License.
-->
-# Installation
-
+## Overview
Flink Agents provides both Python and Java APIs to define a Flink Agents job.
-To try Flink Agents in Python on a local executor, you only need to install
the Flink Agents Python package.
-
-To define a Flink Agents job using the Java API, or to run the job in a Flink
cluster, you need to install both the Flink Agents Python and Java
dependencies.
+To try Flink-Agents in Python or Java, user can only install the correspond
package.
Review Comment:
This is incorrect. To run a Python job in a Flink cluster, you'll also need
the java packages.
I think it's too complicated to explain when to install python / java only,
and when to install both. The benefit for users to install one less package is
probably weaker than the confusion for users to understand what packages they
need. So let's just tell our users to always install both.
##########
docs/content/docs/get-started/installation.md:
##########
@@ -22,47 +22,46 @@ specific language governing permissions and limitations
under the License.
-->
-# Installation
-
+## Overview
Flink Agents provides both Python and Java APIs to define a Flink Agents job.
-To try Flink Agents in Python on a local executor, you only need to install
the Flink Agents Python package.
-
-To define a Flink Agents job using the Java API, or to run the job in a Flink
cluster, you need to install both the Flink Agents Python and Java
dependencies.
+To try Flink-Agents in Python or Java, user can only install the correspond
package.
The sections below show how to install the required dependencies.
-## Install from PyPI
+{{< hint warning >}}
+__NOTE:__ To run on flink cluster, Flink-Agents requires flink version be a
stable release of Flink 1.20.3.
+{{< /hint >}}
+## Install the Official Release
+
+#### Install Python Packages
{{< hint warning >}}
__Note:__ This will be available after Flink Agents is released.
{{< /hint >}}
+We recommand creating a Python virtual environment to install the Flink Agents
Python library.
+
To install the latest Flink Agents release, run:
```shell
python -m pip install flink-agents
```
-<!-- TODO: link to local quickstart example docs -->
-Now you can run a Flink Agents job on the local executor.
-See [local quickstart example]() for end-to-end examples of running on the
local executor.
-
+Now you can run a python Flink Agents job.
+See [quickstart example]({{< ref "docs/get-started/quickstart/workflow_agent"
>}}) for end-to-end examples of running on Flink.
Review Comment:
If we are telling users to always install both packages, we probably want to
remove these paragraph, or move it to somewhere else.
##########
docs/content/docs/get-started/installation.md:
##########
@@ -80,68 +79,24 @@ To clone from Git, run:
git clone https://github.com/apache/flink-agents.git
```
-### Java Build
+### Build
+To run on a Flink cluster, we need build the whole project.
-The Python wheel depends on the Flink Agents Java modules, so we need to build
Flink Agents Java modules first, run:
+We provide a script to run:
```shell
cd flink-agents
-mvn clean install -DskipTests
+./tools/build.sh
```
-### Python Build and Install
-
-Then we can build and install the Flink Agents wheel.
-
-{{< tabs>}}
-{{< tab "uv (Recommended)" >}}
-
-uv is a modern, fast Python package manager that offers significant
performance
-improvements over pip.
-
-If uv is not installed already, you can install it with the following command:
-
-```shell
-pip install uv
-```
-Please see [uv
installation](https://docs.astral.sh/uv/getting-started/installation) for more
detail.
-
-```shell
-cd python
-
-# Build sdist and wheel into python/dist/
-uv run python -m build
-
-# Install the built wheel into the environment
-uv pip install dist/*.whl
-```
-
-{{< /tab >}}
-
-{{< tab "pip" >}}
-
-We also support building and installing with pip
-
-```shell
-cd python
-
-# Build sdist and wheel into python/dist/
-python -m build
-
-# Install the built wheel into the environment
-python -m pip install dist/*.whl
-```
-
-{{< /tab >}}
-{{< /tabs >}}
-
### Install Flink Agents to Flink
To install the Java dependencies to Flink, run:
Review Comment:
Why only installing the java dependencies? What happen to the python?
##########
docs/content/docs/get-started/installation.md:
##########
@@ -80,68 +79,24 @@ To clone from Git, run:
git clone https://github.com/apache/flink-agents.git
```
-### Java Build
+### Build
+To run on a Flink cluster, we need build the whole project.
-The Python wheel depends on the Flink Agents Java modules, so we need to build
Flink Agents Java modules first, run:
+We provide a script to run:
```shell
cd flink-agents
-mvn clean install -DskipTests
+./tools/build.sh
```
-### Python Build and Install
-
-Then we can build and install the Flink Agents wheel.
-
-{{< tabs>}}
-{{< tab "uv (Recommended)" >}}
-
-uv is a modern, fast Python package manager that offers significant
performance
-improvements over pip.
-
-If uv is not installed already, you can install it with the following command:
-
-```shell
-pip install uv
-```
-Please see [uv
installation](https://docs.astral.sh/uv/getting-started/installation) for more
detail.
-
-```shell
-cd python
-
-# Build sdist and wheel into python/dist/
-uv run python -m build
-
-# Install the built wheel into the environment
-uv pip install dist/*.whl
-```
-
-{{< /tab >}}
-
-{{< tab "pip" >}}
-
-We also support building and installing with pip
-
-```shell
-cd python
-
-# Build sdist and wheel into python/dist/
-python -m build
-
-# Install the built wheel into the environment
-python -m pip install dist/*.whl
-```
-
-{{< /tab >}}
-{{< /tabs >}}
-
### Install Flink Agents to Flink
To install the Java dependencies to Flink, run:
-<!-- TODO: fill in the command after Flink Agents produce uber jar -->
```shell
+cd flink-agents
Review Comment:
Remote the empty line.
--
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]
