Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions local-antora-playbook.yml
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,14 @@ antora:
- require: '@redpanda-data/docs-extensions-and-macros/extensions/add-global-attributes'
- require: '@redpanda-data/docs-extensions-and-macros/extensions/version-fetcher/set-latest-version'
- require: '@redpanda-data/docs-extensions-and-macros/extensions/replace-attributes-in-attachments'
data:
replacements:
- components:
- 'ROOT'
- 'redpanda-labs'
file_patterns:
- '**/docker-compose.yaml'
- '**/docker-compose.yml'
- require: '@redpanda-data/docs-extensions-and-macros/extensions/validate-attributes'
- require: '@redpanda-data/docs-extensions-and-macros/extensions/find-related-docs'
- require: '@redpanda-data/docs-extensions-and-macros/extensions/find-related-labs'
Expand Down
6 changes: 5 additions & 1 deletion modules/get-started/pages/intro-to-rpk.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,14 @@ After you install `rpk`, you can use it to:
* Set up access control lists (ACLs) and other security features
* Create topics, produce to topics, and consume from topics

See also:
See also:

* xref:get-started:rpk-install.adoc[]
* xref:get-started:config-rpk-profile.adoc[]
// This topic is not available in our Cloud docs.
ifndef::env-cloud[]
* xref:get-started:rpk-quickstart.adoc[]
endif::[]

== Specify command properties

Expand Down
4 changes: 2 additions & 2 deletions modules/get-started/pages/rpk-install.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ include::get-started:partial$install-rpk-macos.adoc[]

== Next steps

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

// end::single-source[]
// Excluding the rpk quickstart from single-sourcing because it is not available in our Cloud docs.
Explore `rpk` with the xref:get-started:rpk-quickstart.adoc[].
2 changes: 1 addition & 1 deletion modules/get-started/partials/install-rpk-linux.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ curl -LO https://github.com/redpanda-data/redpanda/releases/latest/download/rpk-
----
====

TIP: You can use `rpk` on Windows with https://learn.microsoft.com/windows/wsl/install[WSL]^. Note that commands that require Redpanda to be installed on your machine are not supported, such as xref:reference:rpk/rpk-container.adoc[`rpk container`] commands, xref:reference:rpk/rpk-iotune.adoc[`rpk iotune`], and xref:reference:rpk/rpk-redpanda.adoc[`rpk redpanda`] commands.
TIP: You can use `rpk` on Windows only with https://learn.microsoft.com/windows/wsl/install[WSL^]. However, commands that require Redpanda to be installed on your machine are not supported, such as xref:ROOT:reference:rpk/rpk-container/rpk-container.adoc[`rpk container`] commands, xref:ROOT:reference:rpk/rpk-iotune.adoc[`rpk iotune`], and xref:ROOT:reference:rpk/rpk-redpanda/rpk-redpanda.adoc[`rpk redpanda`] commands.

// end::latest[]

Expand Down
Loading