Skip to content

[FLINK-23140][docs] Fix SourceFunction documentation link#28494

Open
Vamsi-klu wants to merge 2 commits into
apache:masterfrom
Vamsi-klu:FLINK-23140-sourcefunction-doc-link
Open

[FLINK-23140][docs] Fix SourceFunction documentation link#28494
Vamsi-klu wants to merge 2 commits into
apache:masterfrom
Vamsi-klu:FLINK-23140-sourcefunction-doc-link

Conversation

@Vamsi-klu

@Vamsi-klu Vamsi-klu commented Jun 19, 2026

Copy link
Copy Markdown

What is the purpose of the change

This PR fixes the DataStream Data Sources documentation for the legacy source function APIs.

The current documentation mentions SourceFunction, ParallelSourceFunction, and RichParallelSourceFunction together when explaining how users can implement custom sources with StreamExecutionEnvironment.addSource(...). SourceFunction was updated to link to the current legacy source package, but the two related APIs in the same sentence were still left as plain code text.

To keep the documentation consistent and easier to navigate, this PR links all three legacy source APIs to their current source files:

  • SourceFunction
  • ParallelSourceFunction
  • RichParallelSourceFunction

The same update is applied to both the English and Chinese DataStream documentation.

This closes FLINK-23140.

Brief change log

  • Updated the English DataStream Data Sources documentation to link all three legacy source function APIs.
  • Updated the Chinese DataStream Data Sources documentation with the same set of legacy source API links.
  • Kept the change limited to documentation; no runtime code, API behavior, or dependency changes are included.

Verifying this change

This change is a documentation-only update without new test coverage.

Verified locally with:

  • test -f flink-runtime/src/main/java/org/apache/flink/streaming/api/functions/source/legacy/SourceFunction.java
  • test -f flink-runtime/src/main/java/org/apache/flink/streaming/api/functions/source/legacy/ParallelSourceFunction.java
  • test -f flink-runtime/src/main/java/org/apache/flink/streaming/api/functions/source/legacy/RichParallelSourceFunction.java
  • git diff --check

The verification confirms that each linked target file exists and that the Markdown diff does not contain whitespace errors.

Does this pull request potentially affect one of the following parts:

  • Dependencies (does it add or upgrade a dependency): no
  • The public API, i.e., is any changed class annotated with @Public(Evolving): no
  • The serializers: no
  • The runtime per-record code paths (performance sensitive): no
  • Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Kubernetes/Yarn, ZooKeeper: no
  • The S3 file system connector: no

Documentation

  • Does this pull request introduce a new feature? no
  • If yes, how is the feature documented? not applicable

Was generative AI tooling used to co-author this PR?
  • Yes (OpenAI Codex)

Generated-by: OpenAI Codex

@flinkbot

flinkbot commented Jun 19, 2026

Copy link
Copy Markdown
Collaborator

CI report:

Bot commands The @flinkbot bot supports the following commands:
  • @flinkbot run azure re-run the last Azure build

Comment thread docs/content.zh/docs/dev/datastream/overview.md Outdated
@github-actions github-actions Bot added the community-reviewed PR has been reviewed by the community. label Jun 20, 2026
@Vamsi-klu Vamsi-klu force-pushed the FLINK-23140-sourcefunction-doc-link branch from 3f5ed99 to 3cd52e4 Compare June 20, 2026 16:29
@spuru9

spuru9 commented Jun 20, 2026

Copy link
Copy Markdown
Contributor

Can you update the description as needed by the PULL_REQUEST template as well.

@Vamsi-klu

Copy link
Copy Markdown
Author

Thanks, updated.

I pushed the follow-up docs change so SourceFunction, ParallelSourceFunction, and RichParallelSourceFunction are linked consistently in both the English and Chinese DataStream docs. I also updated the PR description to include the remaining PULL_REQUEST_TEMPLATE.md sections, including the impact checklist, documentation section, verification details, and AI tooling disclosure.

@spuru9 spuru9 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

community-reviewed PR has been reviewed by the community.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants