DOC-824 rpk with wsl (#908)

redpanda-data · Jan 28, 2025 · d10ccdf · d10ccdf
1 parent 9328ffa
commit d10ccdf
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/modules/get-started/pages/quick-start.adoc b/modules/get-started/pages/quick-start.adoc
@@ -207,8 +207,6 @@ To test external connectivity using your local machine:
 
 . Install rpk on your local machine:
 +
-NOTE: The `rpk` binary is not supported on Windows.
-+
 [tabs]
 ======
 Linux::

diff --git a/modules/get-started/partials/install-rpk-linux.adoc b/modules/get-started/partials/install-rpk-linux.adoc
@@ -22,6 +22,9 @@ curl -LO https://github.com/redpanda-data/redpanda/releases/latest/download/rpk-
   unzip rpk-linux-arm64.zip -d ~/.local/bin/
 ----
 ====
+
+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.
+
 // end::latest[]
 
 ifndef::env-cloud[]
-Original file line number
+Diff line change
@@ Expand Up / @@ -207,8 +207,6 @@ To test external connectivity using your local machine: @@
     . Install rpk on your local machine:
     +
-    NOTE: The `rpk` binary is not supported on Windows.
-    +
     [tabs]
     ======
     Linux::
@@ Expand Down @@