-
Notifications
You must be signed in to change notification settings - Fork 13.8k
[FLINK-20905][k8s] Format the description of 'kubernetes.container.image' option #14597
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
Conversation
|
Thanks a lot for your contribution to the Apache Flink project. I'm the @flinkbot. I help the community Automated ChecksLast check on commit 9e0cb70 (Fri May 28 07:06:12 UTC 2021) Warnings:
Mention the bot in a comment to re-run the automated checks. Review Progress
Please see the Pull Request Review Guide for a full explanation of the review process. DetailsThe 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 commandsThe @flinkbot bot supports the following commands:
|
wangyang0918
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for creating this PR. This change makes sense. I left a minor comments. Could you please get it integrated before merging.
| link("https://hub.docker.com/_/flink?tab=tags", "here"), | ||
| link( | ||
| "https://hub.docker.com/r/apache/flink", | ||
| "DockerHub")) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| "DockerHub")) | |
| "apache/flink DockerHub repository")) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe using "apache/flink DockerHub repository" is better since the official docker images are also located in the DockerHub.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for you suggestion @wangyang0918, I have updated and submitted again, please take a look.
wangyang0918
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. +1 for merging.
| + "Visit %s for the official docker images provided by the Flink project. The Flink project also publishes docker images to %s.", | ||
| link("https://hub.docker.com/_/flink?tab=tags", "here"), | ||
| link( | ||
| "https://hub.docker.com/r/apache/flink", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| "https://hub.docker.com/r/apache/flink", | |
| "https://hub.docker.com/r/apache/flink?tab=tags", |
nit: Maybe also add the "?tab=tags" is better to align with official image link.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok, but I tried it and found that https://hub.docker.com/r/apache/flink?tab=tags is not align with the https://hub.docker.com/_/flink?tab=tags, maybe the correct link should be https://hub.docker.com/r/apache/flink/tags
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Strange. But you are right. Could you update it?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done. Take a look, THX!
|
cc @xintongsong Could you have a final check and help with merging? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
TBH, I think the current description for this configuration option is a bit confusing for the users. It recommends two images, without explaining the differences between them and how should users choose between them.
However, the purpose of this PR is simply to improve the format for the links. To this purpose, the changes look good to me. Merging this once passing the ci tests.
What is the purpose of the change
The description of ConfigOption 'kubernetes.container.image' has a URL link, so a reasonable way is to use Text Description with Link to format.
Brief change log
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:
@Public(Evolving): (yes / no)Documentation