Skip to content

KAFKA-20027: Fix the broken quick start link #21243

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
Merged
chia7712 merged 4 commits into from
Jan 6, 2026
Merged

KAFKA-20027: Fix the broken quick start link #21243

chia7712 merged 4 commits into from
Jan 6, 2026

Conversation

@JimmyWang6
Copy link
Contributor

@JimmyWang6 JimmyWang6 commented Jan 3, 2026 •
edited by github-actions bot
Loading

This PR fix the broken quickstart link on the connector page. image

Reviewers: Ken Huang [email protected], Chia-Ping Tsai
[email protected]

@github-actions github-actions bot added triage PRs from the community docs small Small PRs labels Jan 3, 2026
m1a2st
m1a2st reviewed Jan 3, 2026
View reviewed changes
Copy link
Collaborator

@m1a2st m1a2st 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 patch, coulld you also fix this link?

Image

@JimmyWang6
Copy link
Contributor Author

JimmyWang6 commented Jan 3, 2026

@m1a2st Good idea, done:)

@github-actions github-actions bot removed the triage PRs from the community label Jan 4, 2026
chia7712
chia7712 reviewed Jan 4, 2026
View reviewed changes
docs/getting-started/quickstart.md Outdated
In this quickstart we'll see how to run Kafka Connect with simple connectors that import data from a file to a Kafka topic and export data from a Kafka topic to a file.

First, make sure to add `connect-file-4.3.0.jar` to the `plugin.path` property in the Connect worker's configuration. For the purpose of this quickstart we'll use a relative path and consider the connectors' package as an uber jar, which works when the quickstart commands are run from the installation directory. However, it's worth noting that for production deployments using absolute paths is always preferable. See [plugin.path](/documentation/#connectconfigs_plugin.path) for a detailed description of how to set this config.
First, make sure to add `connect-file-4.3.0.jar` to the `plugin.path` property in the Connect worker's configuration. For the purpose of this quickstart we'll use a relative path and consider the connectors' package as an uber jar, which works when the quickstart commands are run from the installation directory. However, it's worth noting that for production deployments using absolute paths is always preferable. See [plugin.path](/configuration/kafka-connect-configs/#connectconfigs_plugin.path) for a detailed description of how to set this config.
Copy link
Member

@chia7712 chia7712 Jan 4, 2026

Choose a reason for hiding this comment

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

Is this fix correct? It does not seem to point to an existing file

Copy link
Contributor Author

@JimmyWang6 JimmyWang6 Jan 5, 2026

Choose a reason for hiding this comment

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

Apologies, the original URL was missing the version prefix. It looks like using a relative path is the best approach, and it should be working now.

Copy link
Member

@chia7712 chia7712 Jan 5, 2026

Choose a reason for hiding this comment

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

It appears the correct link is ../configuration/kafka-connect-configs/#connectconfigs_plugin.path, right?

Copy link
Contributor Author

@JimmyWang6 JimmyWang6 Jan 5, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

Thanks for the comment. The link ../configuration/kafka-connect-configs/#connectconfigs_plugin.path leads to a 404 error.
image
However, ../../configuration/kafka-connect-configs/#connectconfigs_plugin.path works in my environment. I am not sure if this difference is due to my specific testing method or environment setup.
image

Copy link
Collaborator

@m1a2st m1a2st Jan 5, 2026

Choose a reason for hiding this comment

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

I tested this on the website, and it seems that ../../configuration/kafka-connect-configs/#connectconfigs_plugin.path redirects to the correct section.

Copy link
Member

@chia7712 chia7712 Jan 6, 2026

Choose a reason for hiding this comment

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

My mistake, the current version is actually correct

@chia7712 chia7712 merged commit 6b5a2e4 into apache:trunk Jan 6, 2026
28 checks passed
chia7712 pushed a commit that referenced this pull request Jan 6, 2026
@JimmyWang6 @chia7712
KAFKA-20027 Fix the broken quick start link (#21243)
5acbf7a 
This PR fix the broken `quickstart` link on the connector page. <img
width="1094" height="604" alt="image"

src="https://github.com/user-attachments/assets/d9a160b4-de09-422b-bd5a-c3bca6e73cac"
/>

Reviewers: Ken Huang <[email protected]>, Chia-Ping Tsai
 <[email protected]>
chia7712 pushed a commit that referenced this pull request Jan 6, 2026
@JimmyWang6 @chia7712
KAFKA-20027 Fix the broken quick start link (#21243)
c3ab834 
This PR fix the broken `quickstart` link on the connector page. <img
width="1094" height="604" alt="image"

src="https://github.com/user-attachments/assets/d9a160b4-de09-422b-bd5a-c3bca6e73cac"
/>

Reviewers: Ken Huang <[email protected]>, Chia-Ping Tsai
 <[email protected]>
chia7712 pushed a commit that referenced this pull request Jan 6, 2026
@JimmyWang6 @chia7712
KAFKA-20027 Fix the broken quick start link (#21243)
bd15681 
This PR fix the broken `quickstart` link on the connector page. <img
width="1094" height="604" alt="image"

src="https://github.com/user-attachments/assets/d9a160b4-de09-422b-bd5a-c3bca6e73cac"
/>

Reviewers: Ken Huang <[email protected]>, Chia-Ping Tsai
 <[email protected]>
chia7712 pushed a commit that referenced this pull request Jan 6, 2026
@JimmyWang6 @chia7712
KAFKA-20027 Fix the broken quick start link (#21243)
34c615d 
This PR fix the broken `quickstart` link on the connector page. <img
width="1094" height="604" alt="image"

src="https://github.com/user-attachments/assets/d9a160b4-de09-422b-bd5a-c3bca6e73cac"
/>

Reviewers: Ken Huang <[email protected]>, Chia-Ping Tsai
 <[email protected]>
Parkerhiphop pushed a commit to Parkerhiphop/kafka that referenced this pull request Jan 6, 2026
@JimmyWang6 @Parkerhiphop
KAFKA-20027 Fix the broken quick start link (apache#21243)
8351ce6 
This PR fix the broken `quickstart` link on the connector page. <img
width="1094" height="604" alt="image"

src="https://github.com/user-attachments/assets/d9a160b4-de09-422b-bd5a-c3bca6e73cac"
/>

Reviewers: Ken Huang <[email protected]>, Chia-Ping Tsai
 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@chia7712 chia7712 chia7712 approved these changes

+1 more reviewer

@m1a2st m1a2st m1a2st left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

ci-approved docs small Small PRs

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@JimmyWang6 @chia7712 @m1a2st