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

Doc:Add attribute for kafka client versions #48

Merged
merged 3 commits into from
Aug 13, 2020

Conversation

karenzone
Copy link
Contributor

Replaces hard-coded kafka client version with an attribute to make updating it easier

@karenzone karenzone added the documentation Improvements or additions to documentation label Jul 31, 2020
@karenzone karenzone force-pushed the attr-kafka-version branch 2 times, most recently from 723623d to aaa06c1 Compare August 12, 2020 20:39
Replaced hard-coded kafka client and doc path version numbers with attributes
to simplify maintenance
Depending on your broker configuration, this can be
either when the record was created (default) or when it was received by the
broker. See more about property log.message.timestamp.type at
https://kafka.apache.org/{kafka_client_doc}/documentation.html#brokerconfigs
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yikes! Here's an oldie!

and
https://kafka.apache.org/25/javadoc/org/apache/kafka/common/errors/InterruptException.html[InterruptException].
https://kafka.apache.org/{kafka_client_doc}/javadoc/org/apache/kafka/common/errors/InterruptException.html[InterruptException].
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This link using /25/ is from a recent PR. Seems like we should standardize it, too. WDYT?

Copy link
Contributor

Choose a reason for hiding this comment

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

👍 most definitely - for correctness these should point to /24 till we upgrade the client

@karenzone karenzone requested a review from kares August 12, 2020 22:28
@karenzone
Copy link
Contributor Author

@kares I replaced the hard-coded values for kafka client and the kafka version in links with attributes. The goal is to have one place to set the values in each file. Then all of the other references will be updated automatically.

@karenzone karenzone changed the title Doc:Add attribute for kafka client version Doc:Add attribute for kafka client versions Aug 12, 2020
Copy link
Contributor

@kares kares left a comment

Choose a reason for hiding this comment

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

👍 this should help the next time we upgrade the client to not forget about docs

@karenzone
Copy link
Contributor Author

Thanks for the review, kares! <3

@karenzone karenzone merged commit 79c18a1 into logstash-plugins:master Aug 13, 2020
@karenzone karenzone deleted the attr-kafka-version branch August 13, 2020 15:26
@karenzone
Copy link
Contributor Author

karenzone commented Aug 13, 2020

This PR is included in changelog/version bump for #46

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

Successfully merging this pull request may close these issues.

2 participants