apache/iceberg

Improve Documentation for Installing Kafka Connect

Open

#12,516 opened on Mar 13, 2025

View on GitHub
 (8 comments) (0 reactions) (0 assignees)Java (1,915 forks)batch import
docsgood first issueimprovementstale

Repository metrics

Stars
 (5,146 stars)
PR merge metrics
 (Avg merge 9d 18h) (158 merged PRs in 30d)

Description

Feature Request / Improvement

The current installation instructions for Kafka connect seem to leave a bit of ambiguity that makes it difficult for users to get started. We should specify exactly what is required to start and in the future we should have a more complete solution which doesn't require building the project.

https://iceberg.apache.org/docs/nightly/kafka-connect/#installation

Currently doesn't mention what the zip is called or if the zip needs to be extracted which seems to be the case according to #12507

See #12507 for more details

Query engine

Kafka Connect

Willingness to contribute

  • I can contribute this improvement/feature independently
  • I would be willing to contribute this improvement/feature with guidance from the Iceberg community
  • I cannot contribute this improvement/feature at this time

Contributor guide

Research direction
Review the current installation documentation at https://iceberg.apache.org/docs/nightly/kafka connect/#installation. Examine issue #12507 for specific feedback on the ambiguity. Update the documentation to explicitly mention the zip file name and that it needs to be extracted. Locate the documentation source file in the repository (likely in the docs folder) and make the necessary edits.
Tech stack
javakafka
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85