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.

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

KAFKA-14669: Use the generated docs for MirrorMaker configs in the doc #13658

Merged
merged 4 commits into from Jul 18, 2023

Conversation

tinaselenge
Copy link
Collaborator

Currently all three generated docs for MirrorMaker contain fields from BASE_CONNECTOR_CONFIG_DEF which results in duplicated fields when using them in the doc. This PR separates BASE_CONNECTOR_CONFIG_DEF from the config definitions for source, checkpoint and heartbeat so that the html docs are generated without duplicated fields.

Committer Checklist (excluded from commit message)

  • Verify design and implementation
  • Verify test coverage and CI build status
  • Verify documentation (including upgrade notes)

Copy link
Contributor

@C0urante C0urante left a comment

Choose a reason for hiding this comment

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

Thanks @tinaselenge, this will be a great enhancement for our docs! Left some thoughts; LMKWYT.

docs/configuration.html Outdated Show resolved Hide resolved
docs/configuration.html Show resolved Hide resolved
docs/configuration.html Show resolved Hide resolved
docs/configuration.html Outdated Show resolved Hide resolved
@tinaselenge
Copy link
Collaborator Author

@C0urante thank you so much for reviewing the PR, good suggestions! I made the changes as you suggested.

Copy link
Contributor

@C0urante C0urante left a comment

Choose a reason for hiding this comment

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

Thanks Tina! Two small comments and then this should be good to go.

docs/ops.html Outdated Show resolved Hide resolved
docs/configuration.html Outdated Show resolved Hide resolved
Copy link
Contributor

@C0urante C0urante left a comment

Choose a reason for hiding this comment

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

LGTM, thanks @tinaselenge!

@C0urante C0urante merged commit 5cb2504 into apache:trunk Jul 18, 2023
1 check failed
jolshan added a commit to confluentinc/kafka that referenced this pull request Jul 18, 2023
* ak/trunk: (110 commits)
  MINOR: Update docs to include ZK deprecation notice and information (apache#14031)
  KAFKA-15091: Fix misleading Javadoc for SourceTask::commit (apache#13948)
  KAFKA-14669: Use the generated docs for MirrorMaker configs in the doc (apache#13658)
  KAFKA-14953: Add tiered storage related metrics (apache#13944)
  KAFKA-15121: Implement the alterOffsets method in the FileStreamSourceConnector and the FileStreamSinkConnector (apache#13945)
  Revert "MINOR: Update .asf.yaml file with refreshed github_whitelist, and collaborators" (apache#14037)
  MINOR: Update .asf.yaml file with refreshed github_whitelist, and collaborators
  KAFKA-14737: Move kafka.utils.json to server-common (apache#13585)
  KAFKA-14647: Move TopicFilter to server-common/utils (apache#13158)
  MINOR: remove unused variable in examples (apache#14021)
  ...
jeqo pushed a commit to jeqo/kafka that referenced this pull request Jul 21, 2023
Cerchie pushed a commit to Cerchie/kafka that referenced this pull request Jul 25, 2023
jeqo pushed a commit to aiven/kafka that referenced this pull request Aug 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants