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

Better documentation for topic commands #1607

Merged
merged 1 commit into from
Jun 27, 2022
Merged

Better documentation for topic commands #1607

merged 1 commit into from
Jun 27, 2022

Conversation

jackdelahunt
Copy link
Contributor

Adds more examples for consume command and adds produce and consume examples to topic root command.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation change
  • Other (please specify)

@jackdelahunt jackdelahunt force-pushed the better-topic-docs branch 2 times, most recently from 2a673e0 to f5c6d75 Compare June 27, 2022 11:59
@jackdelahunt jackdelahunt requested a review from wtrocki June 27, 2022 12:01
Copy link
Collaborator

@wtrocki wtrocki left a comment

Choose a reason for hiding this comment

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

I will try to improve this in separate PR

@@ -603,6 +603,9 @@ one = '''
# Consume from a topic
$ rhoas kafka topic consume --name=topic-1

# Consume from topic and output yaml format
Copy link
Collaborator

Choose a reason for hiding this comment

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

Actually this is problematic right now as command is hidden. I will remove it

@wtrocki wtrocki merged commit 62ad5e4 into main Jun 27, 2022
@wtrocki wtrocki deleted the better-topic-docs branch June 27, 2022 16:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants