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

Add link to the reset offset learning resource page #1048

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

hemahg
Copy link
Contributor

@hemahg hemahg commented Sep 16, 2024

Add link to the reset offset learning resource page

@hemahg hemahg requested a review from a team September 16, 2024 13:23
Comment on lines 75 to 77
<ExternalLink testId={"learn_to_shutdown_members"} href={"https://docs.redhat.com/en/documentation/red_hat_streams_for_apache_kafka/2.7/html-single/kafka_configuration_tuning/index#managing_offset_policy"}>
{t("learn_to_shutdown_members")}
</ExternalLink>
Copy link
Member

Choose a reason for hiding this comment

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

The label and link should maybe go under learning.labels and learning.links. We should also have a link to something in the Apache Kafka documentation for upstream.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@MikeEdgar Is the phrase "Learn how to shut down members" correct to include under learning resources?

Copy link
Member

Choose a reason for hiding this comment

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

@hemahg , yes that seems good.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Isn't the wording a bit... aggressive? Not a native speaker here, but it feels that way

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Copy link
Member

Choose a reason for hiding this comment

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

Yeah, perhaps something like "Learn how to stop consumers" would be better? I'm not sure there is documentation specific to that since it is very dependent on how the consumers are coded. I don't think the link about managing offset policy matches the label.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@shirimordechay, We've been discussing the phrasing for the learning resource, and I wanted to get some additional feedback. @MikeEdgar suggested "Learn how to stop consumers" as a more appropriate phrase, but I'd like to make sure everyone is on board with this change. Do you have any thoughts or suggestions for improving the wording or can help find relevant documentation links?

Copy link

@shirimordechay shirimordechay Sep 17, 2024

Choose a reason for hiding this comment

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

Rephrasing sounds good to me. I believe the doc link is the one @[email protected] has provided, but I'm assuming we'll have a new link for GA. need to confirm that with Paul.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Update the phrase as per @MikeEdgar suggestion, there is no specific document to shutdown the consumer group members

@MikeEdgar MikeEdgar added the ui label Sep 18, 2024
Copy link

sonarcloud bot commented Sep 20, 2024

@MikeEdgar MikeEdgar marked this pull request as draft September 26, 2024 12:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants