DOC-31 add rpk tutorial #935
Conversation
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
| // Do not put page aliases in the single-sourced content | ||
| // tag::single-source[] | ||
|
|
||
| This guide shows you how to use `rpk` to perform fundamental Redpanda tasks, including creating, producing to, describing, and deleting topics, as well as consuming records and managing consumer groups. Following these examples will help you quickly become more familiar with `rpk` commands and integrate them into your workflow. |
There was a problem hiding this comment.
I think it looks great, the only thing I'll add is creating a profile as a first step, so they don't have to wonder how to run the command against a cluster.
Alternatively, we could say that you can try this tutorial using rpk container start which creates a profile automatically and links to the profile docs as additional documentation.
Back when we created the issue we didn't have profiles
There was a problem hiding this comment.
Yeah I was thinking about that. We have the create profile page before this one. But I think we could combine those into a single page. Specially for cloud
|
|
||
| See xref:reference:rpk/rpk-topic/rpk-topic-delete.adoc[]. | ||
|
|
||
| == Next steps |
There was a problem hiding this comment.
If you don't merge this with the rpk Profile page, then add a link to it here.
Also, you should add a link to this page in the Intro to rpk page!
| @@ -0,0 +1,240 @@ | |||
| = Quickstart with rpk | |||
There was a problem hiding this comment.
You could consider moving it this page into the Quickstart section in the left nav, and just have links to it in the pages in the Redpanda CLI section.
There was a problem hiding this comment.
If you do move it there, I'd probably rename the title to something like Redpanda CLI Quickstart and page to rpk-quickstart.adoc.
There was a problem hiding this comment.
Or Redpanda rpk Quickstart?
| @@ -0,0 +1,240 @@ | |||
| = Quickstart with rpk | |||
| :page-categories: rpk | |||
There was a problem hiding this comment.
Needs a :description:, so the description appears in the index page.
| Produced to partition 0 at offset 0 with timestamp 1734640650348. | ||
| Produced to partition 0 at offset 1 with timestamp 1734640653558. | ||
| ---- | ||
|
|
There was a problem hiding this comment.
Should you say you need to Ctrl-C?
Co-authored-by: Michele Cyran <michele@redpanda.com>
|
|
||
| == Next steps | ||
|
|
||
| For the complete list of `rpk` commands and their syntax, see the xref:reference:rpk/index.adoc[rpk reference]. |
There was a problem hiding this comment.
It appears in the navtree as Reference > rpk Commands
The heading on the page also reads rpk Commands
So shouldn't this be see the rpk Command Reference?
|
Thanks for this one--long needed! |
| rpk topic consume tutorial --group tutorial-group | ||
| ---- | ||
|
|
||
| NOTE: The consumer group is created when you consume from the topic. |
There was a problem hiding this comment.
| NOTE: The consumer group is created when you consume from the topic. | |
| NOTE: The consumer group is created when you start consuming from the topic. |
Probably better, wdyt? as when you consume may imply that only is created when you consume records, but the consumer might be idle waiting for new messages and the consumer group still will be created
Description
Resolves https://github.com/redpanda-data/documentation-private/issues/1373
Resolves https://redpandadata.atlassian.net/browse/DOC-31
Review deadline: Jan 7th
Page previews
https://deploy-preview-935--redpanda-docs-preview.netlify.app/current/get-started/rpk-first-steps/
Checks