Skip to content

[FLINK-37658][docs] Improve the Datagen connector docs #26455

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

davidradl
Copy link
Contributor

Amend the DataGen connector docs as agreed in PR 26437.

I have added the example from the PR into the docs and have made small improvements to the text. I have added a Chinese version of the doc change.

What is the purpose of the change

Include a length example for collections - which now works after PR 26437.
Also make minor improvements to the test in this section.

Brief change log

(for example:)

  • The TaskInfo is stored in the blob store on job creation time as a persistent artifact
  • Deployments RPC transmits only the blob storage reference
  • TaskManagers retrieve the TaskInfo from the blob cache

Verifying this change

Please make sure both new and modified tests in this PR follow the conventions for tests defined in our code quality guide.

(Please pick either of the following options)

Doc change - this change is a trivial rework / code cleanup without any test coverage.

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? (docs )

@davidradl
Copy link
Contributor Author

@reswqa as agreed, here are some doc changes as a follow on to #26437. Let me know if you want any changes.

@flinkbot
Copy link
Collaborator

flinkbot commented Apr 14, 2025

CI report:

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

Copy link
Member

@reswqa reswqa left a comment

Choose a reason for hiding this comment

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

Thanks for this PR, left some minor comments.

Signed-off-by: davidradl <david_radley@uk.ibm.com>
@davidradl davidradl reopened this Apr 15, 2025
@davidradl davidradl requested a review from reswqa April 15, 2025 08:11
@davidradl
Copy link
Contributor Author

@reswqa I have made the changes - Let's go to merge.

I notice #25128 provides Chinese translations - you might want to look at that one atfer this has been merged.

I suggest I backport this to v2 and 1.20 WDYT?

Copy link
Member

@reswqa reswqa left a comment

Choose a reason for hiding this comment

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

Thanks for addressing my comments, LGTM now.

This shall be merged after @RocMarshal vote +1.

@davidradl
Copy link
Contributor Author

@reswqa are you ok with the amendments to the Chinese translations that @RocMarshal has suggested instead of the ones you supplied, I am not in a position to judge!

@reswqa
Copy link
Member

reswqa commented Apr 17, 2025

@reswqa are you ok with the amendments to the Chinese translations that @RocMarshal has suggested instead of the ones you supplied, I am not in a position to judge!

Yes, his suggestion is reasonable.

davidradl and others added 2 commits April 18, 2025 11:35
Co-authored-by: Pan Yuepeng <panyuepeng@apache.org>
Co-authored-by: Pan Yuepeng <panyuepeng@apache.org>
@davidradl davidradl requested a review from RocMarshal April 18, 2025 10:36
@davidradl
Copy link
Contributor Author

I have included the suggested changes @RocMarshal thanks

@davidradl davidradl closed this Apr 18, 2025
@davidradl davidradl reopened this Apr 18, 2025
Copy link
Contributor

@RocMarshal RocMarshal left a comment

Choose a reason for hiding this comment

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

Thanks @davidradl for the update and @reswqa for the confirmation.
LGTM +1 now.

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

Successfully merging this pull request may close these issues.

4 participants