Skip to content
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.

Sign up for GitHub

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

Jump to bottom

[FLINK-22722][docs/kafka] Add documentation for Kafka new source #15974

Merged
merged 2 commits into from
Jun 1, 2021
Merged

[FLINK-22722][docs/kafka] Add documentation for Kafka new source #15974

merged 2 commits into from
Jun 1, 2021

Conversation

PatrickRen
Copy link
Contributor

What is the purpose of the change

This pull request adds documentation for Kafka new source.

Brief change log

  • Add documentation for Kafka new source

Verifying this 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/Mesos, 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)

@PatrickRen
Copy link
Contributor Author

Hi @becketqin , can you please have a review on this PR for documentation of Kafka new source? Thanks~

@flinkbot
Copy link
Collaborator

flinkbot commented May 20, 2021 •
edited
Loading

Thanks a lot for your contribution to the Apache Flink project. I'm the @flinkbot. I help the community
to review your pull request. We will use this comment to track the progress of the review.

Automated Checks

Last check on commit ce7e539 (Sat Aug 28 12:13:15 UTC 2021)

Warnings:

  • Documentation files were touched, but no docs/content.zh/ files: Update Chinese documentation or file Jira ticket.

Mention the bot in a comment to re-run the automated checks.

Review Progress

  • ❓ 1. The [description] looks good.
  • ❓ 2. There is [consensus] that the contribution should go into to Flink.
  • ❓ 3. Needs [attention] from.
  • ❓ 4. The change fits into the overall [architecture].
  • ❓ 5. Overall code [quality] is good.

Please see the Pull Request Review Guide for a full explanation of the review process.


The Bot is tracking the review progress through labels. Labels are applied according to the order of the review items. For consensus, approval by a Flink committer of PMC member is required Bot commands
The @flinkbot bot supports the following commands:

  • @flinkbot approve description to approve one or more aspects (aspects: description, consensus, architecture and quality)
  • @flinkbot approve all to approve all aspects
  • @flinkbot approve-until architecture to approve everything until architecture
  • @flinkbot attention @username1 [@username2 ..] to require somebody's attention
  • @flinkbot disapprove architecture to remove an approval you gave earlier

@flinkbot
Copy link
Collaborator

flinkbot commented May 20, 2021 •
edited
Loading

CI report:

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

becketqin
becketqin approved these changes May 26, 2021
View reviewed changes
Copy link
Contributor

@becketqin becketqin left a comment

Choose a reason for hiding this comment

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

@PatrickRen Thanks for the patch. The doc LGTM overall. Just some minor comments.

docs/content/docs/connectors/datastream/kafka.md Outdated
Kafka source is designed to support both streaming and batch running mode. By default, the KafkaSource
is set to run in streaming manner, thus never stops until Flink job fails or is cancelled. You can use
```setBounded(OffsetInitializer)``` to specify stopping offsets and set the source running in
batch mode. When all partitions have reached their stooping offsets, the source will exit.
Copy link
Contributor

Choose a reason for hiding this comment

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

typo "stooping"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed in ce7e539

docs/content/docs/connectors/datastream/kafka.md Outdated
### Dynamic Partition Discovery
In order to handle scenarios like topic scaling-out or topic creation without restarting the Flink
job, Kafka source can be configured to periodically discover new partitions under provided
topic-partition subscribing pattern. The discovery is disabled by default. To enable this feature,
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we highlight that "The discovery is disabled by default"? It is important for users to know this.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added a warning box in ce7e539

@becketqin
Copy link
Contributor

Thanks for the patch. LGTM.

@becketqin becketqin merged commit b582991 into apache:master Jun 1, 2021
@becketqin
Copy link
Contributor

Merged to master: b582991

PatrickRen added a commit to PatrickRen/flink that referenced this pull request Jul 5, 2021
@PatrickRen
[FLINK-22722][docs/kafka] Add documentation for Kafka new source (apa…
d2e2dee 
…che#15974)

(cherry picked from commit b582991)
@PatrickRen PatrickRen mentioned this pull request Jul 5, 2021
Merged
becketqin pushed a commit that referenced this pull request Jul 13, 2021
@PatrickRen @becketqin
[FLINK-22722][docs/kafka] Add documentation for Kafka new source (#15974
ef21d50 
)

(cherry picked from commit b582991)
jnh5y pushed a commit to jnh5y/flink that referenced this pull request Dec 18, 2023
@PatrickRen @zentol
[FLINK-22722][docs/kafka] Add documentation for Kafka new source (apa…
8a02db3 
…che#15974)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@becketqin becketqin becketqin approved these changes

Assignees
No one assigned
Labels
component=Documentation review=description?
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@PatrickRen @flinkbot @becketqin @rmetzger