Skip to content

Commit 796ec14

Browse files
committed
update with latest doc reviews
1 parent 69a8393 commit 796ec14

File tree

4 files changed

+11
-5
lines changed

4 files changed

+11
-5
lines changed

modules/ROOT/nav.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
** xref:get-started:quickstarts.adoc[Quickstarts]
99
*** xref:get-started:quick-start.adoc[Redpanda Self-Managed]
1010
*** xref:console:quickstart.adoc[Redpanda Console]
11+
*** xref:get-started:rpk-quickstart.adoc[]
1112
*** xref:get-started:docker-compose-labs.adoc[Docker Compose Labs]
1213
** xref:get-started:licensing/index.adoc[Redpanda Licensing]
1314
*** xref:get-started:licensing/overview.adoc[Editions and Enterprise Features]
@@ -24,7 +25,6 @@
2425
** xref:get-started:rpk/index.adoc[Redpanda CLI]
2526
*** xref:get-started:intro-to-rpk.adoc[Introduction to rpk]
2627
*** xref:get-started:rpk-install.adoc[]
27-
*** xref:get-started:rpk-first-steps.adoc[]
2828
*** xref:get-started:config-rpk-profile.adoc[]
2929
*** xref:get-started:broker-admin.adoc[]
3030
*** xref:get-started:admin-addresses.adoc[]

modules/get-started/pages/intro-to-rpk.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,10 @@ After you install `rpk`, you can use it to:
1111
* Set up access control lists (ACLs) and other security features
1212
* Create topics, produce to topics, and consume from topics
1313
14-
See also: xref:get-started:rpk-install.adoc[]
14+
See also:
15+
xref:get-started:rpk-install.adoc[]
16+
xref:get-started:config-rpk-profile.adoc[]
17+
xref:get-started:rpk-quickstart.adoc[]
1518

1619
== Specify command properties
1720

modules/get-started/pages/rpk-install.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ include::get-started:partial$install-rpk-macos.adoc[]
3535

3636
== Next steps
3737

38-
Explore rpk with the xref:rpk-first-steps.adoc[] guide.
38+
Explore rpk with the xref:rpk-quickstart.adoc[] guide.
3939
For the complete list of `rpk` commands and their syntax, see the xref:reference:rpk/index.adoc[rpk reference].
4040

4141
// end::single-source[]

modules/get-started/pages/rpk-first-steps.adoc renamed to modules/get-started/pages/rpk-quickstart.adoc

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
1-
= Quickstart with rpk
1+
= Redpanda CLI Quickstart
22
:page-categories: rpk
3+
:description: pass:q[Quickly become familiar with rpk commands for basic Redpanda tasks, including creating, producing to, describing, and deleting topics, as well as consuming records and managing consumer groups.]
34
// Do not put page aliases in the single-sourced content
45
// tag::single-source[]
56

67
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.
78

9+
Consider creating an rpk profile to simplify your development experience with multiple Redpanda clusters by saving and reusing configurations for different clusters. For more information, see xref:get-started:config-rpk-profile.adoc#about-rpk-profiles[About rpk profiles].
10+
811
== Create a topic
912

1013
To start streaming data, first create a topic as the destination for your records:
@@ -25,7 +28,7 @@ See xref:reference:rpk/rpk-topic/rpk-topic-create.adoc[].
2528

2629
== Produce records to a topic
2730

28-
Produce records to the topic. Downstream consumers will then be able to read these records.
31+
Produce records to the topic. Downstream consumers will then be able to read these records. To exit the producer session, press `Ctrl+C`:
2932

3033
[source,bash]
3134
----

0 commit comments

Comments
 (0)