Skip to content

[docs] Clarify API and language choices - #1257

Merged
wenjin272 merged 1 commit into
apache:mainfrom
wenjin272:codex/docs-1227-language-contracts
Oct 14, 2026
Merged

wenjin272 merged 1 commit into
apache:mainfrom
wenjin272:codex/docs-1227-language-contracts

Conversation

@wenjin272

Copy link
Copy Markdown
Contributor

Linked issue: Closes #1227

Purpose of change

Add a dedicated guide for choosing the Java, Python, or YAML API, combining Java and Python Actions and Resources, and integrating the Agent into a Java Flink or PyFlink job.

The related Setup, Deployment, FAQ, provider, YAML, Event, and Action documentation now uses the same language dimensions and dependency model. The change also documents the cross-language data contract and current async requirements while removing obsolete local-mode and blanket JDK restrictions.

Tests

  • hugo --source docs --destination /private/tmp/flink-docs-1227-review-final --noBuildLock --cacheDir /private/tmp/flink-docs-1227-review-final-cache
  • Generated-site link check: 1,125 links checked, 0 errors
  • git diff --check

API

No public API changes.

Documentation

  • doc-needed
  • doc-not-needed
  • doc-included

Was this patch authored or co-authored using generative AI tooling?

  • Yes
  • No

Generated-by: Codex (GPT-6)

Document the Java, Python, and YAML API choices, component language support, and cross-language runtime requirements. Align related setup, async, provider, YAML, FAQ, and deployment guidance.

Generated-by: Codex (GPT-6)

Co-authored-by: Codex <codex@openai.com>
@github-actions github-actions Bot added doc-included Your PR already contains the necessary documentation updates. fixVersion/0.4.0 priority/major Default priority of the PR or issue. labels Oct 14, 2026
@wenjin272
wenjin272 merged commit ce684fd into apache:main Oct 14, 2026
29 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc-included Your PR already contains the necessary documentation updates. fixVersion/0.4.0 priority/major Default priority of the PR or issue.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Doc] Clarify API choices, language dimensions, and cross-language contracts

1 participant