You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by we...@apache.org on 2026/10/20 03:40:21 UTC
(flink-agents) branch main updated: [docs] Fix release-branch source links and the Apple Silicon setup note (#1285)
This is an automated email from the ASF dual-hosted git repository.
wenjin272 pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/flink-agents.git
The following commit(s) were added to refs/heads/main by this push:
new 742faf60c [docs] Fix release-branch source links and the Apple Silicon setup note (#1285)
742faf60c is described below
commit 742faf60cc95527b8b834a4cf316f5824865edf5
Author: Sangkyoon Nam <sa...@namsang.co>
AuthorDate: Tue Oct 20 12:40:15 2026 +0900
[docs] Fix release-branch source links and the Apple Silicon setup note (#1285)
Generated-by: Claude Code 2.1.303 (Claude Opus 5.5)
---
docs/content/docs/development/calling-llms/model_routing.md | 8 ++++----
docs/content/docs/development/calling-llms/skills.md | 4 ++--
docs/content/docs/development/create-agent/yaml.md | 2 +-
docs/content/docs/development/decision_models.md | 4 ++--
docs/content/docs/development/integrate_with_flink.md | 2 +-
docs/content/docs/development/react_agent.md | 2 +-
docs/content/docs/get-started/quickstart/_index.md | 2 +-
docs/content/docs/get-started/setup.md | 6 +++---
8 files changed, 15 insertions(+), 15 deletions(-)
diff --git a/docs/content/docs/development/calling-llms/model_routing.md b/docs/content/docs/development/calling-llms/model_routing.md
index 00be59daa..58db5d44b 100644
--- a/docs/content/docs/development/calling-llms/model_routing.md
+++ b/docs/content/docs/development/calling-llms/model_routing.md
@@ -359,8 +359,8 @@ for the persistence and replay guarantees.
## Examples
-- [`ModelRoutingExample`](https://github.com/apache/flink-agents/blob/main/examples/src/main/java/org/apache/flink/agents/examples/ModelRoutingExample.java): rule-based routing between two Ollama models.
-- [`ModelRoutingJudgeExample`](https://github.com/apache/flink-agents/blob/main/examples/src/main/java/org/apache/flink/agents/examples/ModelRoutingJudgeExample.java): the same two models with an LLM judge and candidate descriptions.
-- [`OpenAiModelRoutingExample`](https://github.com/apache/flink-agents/blob/main/examples/src/main/java/org/apache/flink/agents/examples/openai/OpenAiModelRoutingExample.java): rule-based routing between `gpt-4o-mini` and `gpt-4o` over one OpenAI connection.
+- {{< gh_link file="examples/src/main/java/org/apache/flink/agents/examples/ModelRoutingExample.java" name="`ModelRoutingExample`" >}}: rule-based routing between two Ollama models.
+- {{< gh_link file="examples/src/main/java/org/apache/flink/agents/examples/ModelRoutingJudgeExample.java" name="`ModelRoutingJudgeExample`" >}}: the same two models with an LLM judge and candidate descriptions.
+- {{< gh_link file="examples/src/main/java/org/apache/flink/agents/examples/openai/OpenAiModelRoutingExample.java" name="`OpenAiModelRoutingExample`" >}}: rule-based routing between `gpt-4o-mini` and `gpt-4o` over one OpenAI connection.
-All three register their resources on the execution environment and use the [`ModelRoutingAgent`](https://github.com/apache/flink-agents/blob/main/examples/src/main/java/org/apache/flink/agents/examples/agents/ModelRoutingAgent.java) to send requests and handle responses.
+All three register their resources on the execution environment and use the {{< gh_link file="examples/src/main/java/org/apache/flink/agents/examples/agents/ModelRoutingAgent.java" name="`ModelRoutingAgent`" >}} to send requests and handle responses.
diff --git a/docs/content/docs/development/calling-llms/skills.md b/docs/content/docs/development/calling-llms/skills.md
index d0d63c63e..4895d0252 100644
--- a/docs/content/docs/development/calling-llms/skills.md
+++ b/docs/content/docs/development/calling-llms/skills.md
@@ -329,8 +329,8 @@ The complete example sends arithmetic questions such as `What is (2 + 3) * 4?` t
| Language | Example job | Agent definition | Skill instructions |
|----------|-------------|------------------|--------------------|
-| Python | [skills_agent_example.py](https://github.com/apache/flink-agents/blob/main/python/flink_agents/examples/quickstart/skills_agent_example.py) | [MathAgent](https://github.com/apache/flink-agents/blob/main/python/flink_agents/examples/quickstart/agents/math_agent.py) | [SKILL.md](https://github.com/apache/flink-agents/blob/main/python/flink_agents/examples/quickstart/resources/skills/math-calculator/SKILL.md) |
-| Java | [SkillsAgentExample.java](https://github.com/apache/flink-agents/blob/main/examples/src/main/java/org/apache/flink/agents/examples/SkillsAgentExample.java) | [MathAgent](https://github.com/apache/flink-agents/blob/main/examples/src/main/java/org/apache/flink/agents/examples/agents/MathAgent.java) | [SKILL.md](https://github.com/apache/flink-agents/blob/main/examples/src/main/resources/skills/math-calculator/SKILL.md) |
+| Python | {{< gh_link file="python/flink_agents/examples/quickstart/skills_agent_example.py" name="skills_agent_example.py" >}} | {{< gh_link file="python/flink_agents/examples/quickstart/agents/math_agent.py" name="MathAgent" >}} | {{< gh_link file="python/flink_agents/examples/quickstart/resources/skills/math-calculator/SKILL.md" name="SKILL.md" >}} |
+| Java | {{< gh_link file="examples/src/main/java/org/apache/flink/agents/examples/SkillsAgentExample.java" name="SkillsAgentExample.java" >}} | {{< gh_link file="examples/src/main/java/org/apache/flink/agents/examples/agents/MathAgent.java" name="MathAgent" >}} | {{< gh_link file="examples/src/main/resources/skills/math-calculator/SKILL.md" name="SKILL.md" >}} |
The Python example loads its bundled skill through `Skills.from_package`; the Java example uses `Skills.fromClasspath`. Make `bash` and `bc` available on the TaskManagers and prepare the Ollama model configured by the example (`qwen3.5:9b`).
diff --git a/docs/content/docs/development/create-agent/yaml.md b/docs/content/docs/development/create-agent/yaml.md
index 59f6e9216..88a45faf7 100644
--- a/docs/content/docs/development/create-agent/yaml.md
+++ b/docs/content/docs/development/create-agent/yaml.md
@@ -813,7 +813,7 @@ Not every resource type is cross-language. Currently `actions`, `tools`, `chat_m
## YAML API Specification
-To help users and coding agents understand the YAML format and validate YAML files, Flink Agents publishes a language-neutral **JSON Schema** for the YAML document. The schema is checked in at [`docs/yaml-schema.json`](https://github.com/apache/flink-agents/blob/main/docs/yaml-schema.json) — point your IDE's YAML language server at it for inline validation and autocompletion.
+To help users and coding agents understand the YAML format and validate YAML files, Flink Agents publishes a language-neutral **JSON Schema** for the YAML document. The schema is checked in at {{< gh_link file="docs/yaml-schema.json" name="`docs/yaml-schema.json`" >}} — point your IDE's YAML language server at it for inline validation and autocompletion.
The schema benefits both humans and machines:
diff --git a/docs/content/docs/development/decision_models.md b/docs/content/docs/development/decision_models.md
index 2848fb29f..ce29eede3 100644
--- a/docs/content/docs/development/decision_models.md
+++ b/docs/content/docs/development/decision_models.md
@@ -543,9 +543,9 @@ exits with an exception.
## Run the review analysis example
The runnable
-[`decision_review_analysis_example.py`](https://github.com/apache/flink-agents/blob/main/python/flink_agents/examples/decision_models/decision_review_analysis_example.py)
+{{< gh_link file="python/flink_agents/examples/decision_models/decision_review_analysis_example.py" name="`decision_review_analysis_example.py`" >}}
uses the same `ProductReview` input as the workflow-agent quickstart. Its
-[`DecisionReviewAnalysisAgent`](https://github.com/apache/flink-agents/blob/main/python/flink_agents/examples/quickstart/agents/decision_review_analysis_agent.py)
+{{< gh_link file="python/flink_agents/examples/quickstart/agents/decision_review_analysis_agent.py" name="`DecisionReviewAnalysisAgent`" >}}
submits three questions through the built-in Decision Action:
| Question | Type | Business use |
diff --git a/docs/content/docs/development/integrate_with_flink.md b/docs/content/docs/development/integrate_with_flink.md
index 63bf9bf85..9ec8ea98b 100644
--- a/docs/content/docs/development/integrate_with_flink.md
+++ b/docs/content/docs/development/integrate_with_flink.md
@@ -121,7 +121,7 @@ outputStream.print();
The input `DataStream` must be `KeyedStream`, or user should provide `KeySelector` to tell how to convert the input `DataStream` to `KeyedStream`.
-For complete, runnable examples, see [`WorkflowSingleAgentExample.java`](https://github.com/apache/flink-agents/blob/main/examples/src/main/java/org/apache/flink/agents/examples/WorkflowSingleAgentExample.java) (Java) and [`workflow_single_agent_example.py`](https://github.com/apache/flink-agents/blob/main/python/flink_agents/examples/quickstart/workflow_single_agent_example.py) (Python).
+For complete, runnable examples, see {{< gh_link file="examples/src/main/java/org/apache/flink/agents/examples/WorkflowSingleAgentExample.java" name="`WorkflowSingleAgentExample.java`" >}} (Java) and {{< gh_link file="python/flink_agents/examples/quickstart/workflow_single_agent_example.py" name="`workflow_single_agent_example.py`" >}} (Python).
## From/To Flink Table API
diff --git a/docs/content/docs/development/react_agent.md b/docs/content/docs/development/react_agent.md
index e5cf09a9b..269e1f3d1 100644
--- a/docs/content/docs/development/react_agent.md
+++ b/docs/content/docs/development/react_agent.md
@@ -29,7 +29,7 @@ Flink Agents provides `ReActAgent` as a built-in subclass of `Agent` that implem
ReAct Agent is a general paradigm that combines reasoning and action capabilities to solve complex tasks. A `ReActAgent` requires a chat model. You can optionally provide a prompt, an output schema, tools, and skills; the model then decides how to achieve the goal and when to use the capabilities you expose.
{{< hint info >}}
-The snippets on this page are fragments that each focus on a single concept. For an end-to-end runnable walkthrough, see the [Use the Built-in ReAct Agent]({{< ref "docs/get-started/quickstart/react_agent" >}}) and the full source: [`react_agent_example.py`](https://github.com/apache/flink-agents/blob/main/python/flink_agents/examples/quickstart/react_agent_example.py) (Python) and [`ReActAgentExample.java`](https://github.com/apache/flink-agents/blob/main/examples/src/main/java/org/apac [...]
+The snippets on this page are fragments that each focus on a single concept. For an end-to-end runnable walkthrough, see the [Use the Built-in ReAct Agent]({{< ref "docs/get-started/quickstart/react_agent" >}}) and the full source: {{< gh_link file="python/flink_agents/examples/quickstart/react_agent_example.py" name="`react_agent_example.py`" >}} (Python) and {{< gh_link file="examples/src/main/java/org/apache/flink/agents/examples/ReActAgentExample.java" name="`ReActAgentExample.java`" [...]
{{< /hint >}}
## Create a ReAct Agent
diff --git a/docs/content/docs/get-started/quickstart/_index.md b/docs/content/docs/get-started/quickstart/_index.md
index 362fab9bc..ddf2329b8 100644
--- a/docs/content/docs/get-started/quickstart/_index.md
+++ b/docs/content/docs/get-started/quickstart/_index.md
@@ -54,7 +54,7 @@ The Quickstarts submit the example programs that ship with the repository, so yo
them locally. Clone the repository:
```bash
-git clone https://github.com/apache/flink-agents.git
+git clone --branch {{< branch >}} https://github.com/apache/flink-agents.git
cd flink-agents
```
diff --git a/docs/content/docs/get-started/setup.md b/docs/content/docs/get-started/setup.md
index 1525e81c9..c58ee69d1 100644
--- a/docs/content/docs/get-started/setup.md
+++ b/docs/content/docs/get-started/setup.md
@@ -179,7 +179,7 @@ pip install flink-agents apache-flink==${FLINK_VERSION}
```
{{< hint warning >}}
-**Apple Silicon (macOS arm64) + Python 3.12**: `apache-flink` depends on `apache-beam`, which ships no macOS arm64 wheel for Python 3.12, so pip builds it from source. The build pulls the latest `setuptools` (>=82), which removed `pkg_resources`, causing `ModuleNotFoundError: No module named 'pkg_resources'`. That is an upstream issue, tracked in [setuptools#5174](https://github.com/pypa/setuptools/issues/5174). Constrain the build's setuptools to fix it:
+**Apple Silicon (macOS arm64)**: `apache-flink` depends on `apache-beam`, and none of the `apache-beam` versions that `apache-flink` 1.20 through 2.3 accept ships a macOS arm64 wheel, so pip builds it from source on every supported Python version. The build pulls the latest `setuptools` (>=82), which removed `pkg_resources`, causing `ModuleNotFoundError: No module named 'pkg_resources'`. That is an upstream issue, tracked in [setuptools#5174](https://github.com/pypa/setuptools/issues/517 [...]
```shell
echo "setuptools<82" > /tmp/constraint.txt
@@ -192,7 +192,7 @@ PIP_CONSTRAINT=/tmp/constraint.txt pip install flink-agents apache-flink==${FLIN
**Clone the repository:**
```shell
-git clone https://github.com/apache/flink-agents.git
+git clone --branch {{< branch >}} https://github.com/apache/flink-agents.git
```
**Build and install:**
@@ -209,7 +209,7 @@ cd flink-agents
cd ..
```
-On Apple Silicon with Python 3.12, that `pip install` can fail while building `apache-beam`. See
+On Apple Silicon, that `pip install` can fail while building `apache-beam`. See
the warning in [From Official Release](#from-official-release) for the fix.
This script will: