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.

Sign up for GitHub

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

Jump to bottom

DOC-31 add rpk tutorial #935

Merged
merged 17 commits into from
Jan 28, 2025
Merged

DOC-31 add rpk tutorial #935

merged 17 commits into from
Jan 28, 2025

Conversation

Deflaimun
Copy link
Contributor

@Deflaimun Deflaimun commented Dec 19, 2024 •
edited
Loading

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-quickstart/

Checks

  • New feature
  • Content gap
  • Support Follow-up
  • Small fix (typos, links, copyedits, etc)

@Deflaimun Deflaimun requested a review from a team as a code owner December 19, 2024 20:51
@netlify Netlify
Copy link

netlify bot commented Dec 19, 2024 •
edited
Loading

✅ Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit a322e8b
🔍 Latest deploy log https://app.netlify.com/sites/redpanda-docs-preview/deploys/679957b51a46580008cb99b4
😎 Deploy Preview https://deploy-preview-935--redpanda-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@Deflaimun Deflaimun requested a review from r-vasquez December 19, 2024 20:54
@Deflaimun Deflaimun changed the title add rpk tutorial DOC-31 add rpk tutorial Dec 19, 2024
@Feediver1
Copy link
Contributor

Thanks for this one--long needed!

r-vasquez
r-vasquez reviewed Jan 2, 2025
View reviewed changes
Copy link
Contributor

@r-vasquez r-vasquez left a comment

Choose a reason for hiding this comment

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

LGTM, just one small comment.

modules/get-started/pages/rpk-first-steps.adoc Outdated Show resolved Hide resolved
@Deflaimun
Copy link
Contributor Author

Addressed review comments, and moved to quickstart section

micheleRP
micheleRP reviewed Jan 28, 2025
View reviewed changes
modules/get-started/pages/rpk-quickstart.adoc
// tag::single-source[]

This guide shows how to run the Redpanda CLI, `rpk`, for basic Redpanda tasks, including creating, producing to, describing, and deleting topics, as well as consuming records and managing consumer groups. Follow these examples to quickly become familiar with `rpk` commands.

Copy link
Contributor

Choose a reason for hiding this comment

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

The intro should say something about make sure you have rpk installed, or a prereq to install rpk with link: https://deploy-preview-935--redpanda-docs-preview.netlify.app/current/get-started/rpk-install/

micheleRP
micheleRP approved these changes Jan 28, 2025
View reviewed changes
Copy link
Contributor

@micheleRP micheleRP left a comment

Choose a reason for hiding this comment

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

looks great, just a couple minor suggestions

@Deflaimun Deflaimun merged commit 9328ffa into main Jan 28, 2025
1 check passed
@Deflaimun Deflaimun deleted the rpk-tutorial branch January 28, 2025 22:18
@JakeSCahill JakeSCahill mentioned this pull request Jan 29, 2025
Merged
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@r-vasquez r-vasquez r-vasquez approved these changes

@Feediver1 Feediver1 Feediver1 approved these changes

@micheleRP micheleRP micheleRP approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@Deflaimun @Feediver1 @r-vasquez @micheleRP