xintongsong commented on code in PR #700:
URL: https://github.com/apache/flink-agents/pull/700#discussion_r3297744915
##########
docs/content/docs/get-started/installation.md:
##########
@@ -31,7 +31,56 @@ The sections below show how to install the required
dependencies.
__NOTE:__ To run on a Flink cluster, Flink-Agents requires a stable release of
Flink version 1.20.3 or higher. We highly recommend using the **latest stable
release of your chosen Flink minor version** (e.g., for minor version 2.2, use
the latest 2.2.x release).
{{< /hint >}}
-## Install Apache Flink
+## Prerequisites
+
+Both the script-based and manual installation paths require:
+
+* **Java 11+** on your `PATH`. Java 21+ is recommended when using the Java API
— see the table below for the version-specific limitations.
+* **Python 3.10, 3.11, or 3.12** (only required if you plan to use the Python
API or PyFlink).
+
+For building Flink Agents from source, you additionally need:
+- Unix-like environment (Linux, macOS, Cygwin, or WSL)
+- Git
+- Maven 3
+
+### Java Versions
+
+For running an agent built with the **Python API**, you can use any Java
version 11 or higher.
+
+When using the **Java API**, there are some functionality limitations for
earlier Java versions, as detailed below:
+
+| Java Version | Limitations |
+|--------------|------------------------|
+| Java 21+ | No limitations. |
+| Java 11-20 | Async execution is unavailable. |
+
+{{< hint info >}}
+**Note**: If you want to use python 3.12, you need install Flink above 2.1
(including 2.1).
+{{< /hint >}}
+
+## Quick install (recommended)
+
+The `install.sh` script provisions everything you need: it downloads Apache
Flink, creates a Python virtual environment, installs `flink-agents` and
`apache-flink` into it, and copies the required JARs into `$FLINK_HOME/lib`.
+
+Run the one-liner from any directory you want the virtual environment created
in:
+
+```shell
+curl -fsSL
https://raw.githubusercontent.com/apache/flink-agents/main/tools/install.sh |
bash
+```
+
+### What the script does
+
+- Verifies that Java 11+ is available on your `PATH`. It does **not** install
Java for you.
+- Downloads and extracts Apache Flink into `$INSTALL_DIR` (default:
`$HOME/.local/flink`), or reuses an existing `$FLINK_HOME` if you tell it not
to install Flink.
+- Creates a Python virtual environment (default: `./.flink-agents-env`) and
runs `pip install flink-agents apache-flink` inside it.
+- Copies `flink-python-<version>.jar`, `flink-agents-dist-common-*.jar`, and
the version-specific `flink-agents-dist-*` thin JAR into `$FLINK_HOME/lib`.
+- Runs post-install verification (Flink binary, Python package, and JAR
presence) before exiting.
Review Comment:
I think this section is unnecessary. The installation script itself well
explains what it does with the step-by-step prompts. That makes this section
here less helpful, while introducing the maintenance overhead of keeping the
descriptions consistent with the evolving scripts.
--
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]
