From 3bedb29216d79d469e77d9e725017418d81a3bc0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=B6nke=20Liebau?= Date: Thu, 13 Mar 2025 17:13:09 +0100 Subject: [PATCH 1/3] Adapt text about no prebuilt windows binaries to say "it is impossible" --- docs/modules/stackablectl/pages/installation.adoc | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/modules/stackablectl/pages/installation.adoc b/docs/modules/stackablectl/pages/installation.adoc index 7c828b04..4747fc5f 100644 --- a/docs/modules/stackablectl/pages/installation.adoc +++ b/docs/modules/stackablectl/pages/installation.adoc @@ -96,8 +96,13 @@ up asking if you want to allow access for `stackablectl`. You must allow access. Windows:: + -- -Currently, there are no pre-built binaries available for Windows. Please refer to xref:#building-from-source[this] -section to learn how to build the binary from source. +Currently, there are no pre-built binaries available for Windows. At the time of writing this compiling `stackablectl` on +Windows was impossible due to upstream bugs. +While it may have become possible since then, it'll still provide significant challenges due to high technical complexity +related to FFI, cgo and Windows-specific issues. + +If you do want to attempt it, please refer to xref:#building-from-source[this] section - and if you are successful, by +all means, give us a shout and we will reward you handsomely!! -- ==== From c2f94234314c3fdd675f53e3a93403ab85e47665 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=B6nke=20Liebau?= Date: Thu, 13 Mar 2025 17:16:47 +0100 Subject: [PATCH 2/3] Add recommendation for wsl --- docs/modules/stackablectl/pages/installation.adoc | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/modules/stackablectl/pages/installation.adoc b/docs/modules/stackablectl/pages/installation.adoc index 4747fc5f..df696393 100644 --- a/docs/modules/stackablectl/pages/installation.adoc +++ b/docs/modules/stackablectl/pages/installation.adoc @@ -101,7 +101,9 @@ Windows was impossible due to upstream bugs. While it may have become possible since then, it'll still provide significant challenges due to high technical complexity related to FFI, cgo and Windows-specific issues. -If you do want to attempt it, please refer to xref:#building-from-source[this] section - and if you are successful, by +For Windows users, WSL will probably be the option for using `stackablectl`. + +If you do want to attempt compiling for Windows, please refer to xref:#building-from-source[this] section - and if you are successful, by all means, give us a shout and we will reward you handsomely!! -- ==== From e346b0e4f33610cd4692c91424a99ebfa11e9d05 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=B6nke=20Liebau?= Date: Thu, 13 Mar 2025 17:25:32 +0100 Subject: [PATCH 3/3] Apply suggestions from code review by Lars Co-authored-by: Lars Francke --- docs/modules/stackablectl/pages/installation.adoc | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/modules/stackablectl/pages/installation.adoc b/docs/modules/stackablectl/pages/installation.adoc index df696393..0f4870f2 100644 --- a/docs/modules/stackablectl/pages/installation.adoc +++ b/docs/modules/stackablectl/pages/installation.adoc @@ -96,15 +96,14 @@ up asking if you want to allow access for `stackablectl`. You must allow access. Windows:: + -- -Currently, there are no pre-built binaries available for Windows. At the time of writing this compiling `stackablectl` on -Windows was impossible due to upstream bugs. +Currently, there are no pre-built binaries available for Windows. +At the time of writing, compiling `stackablectl` on Windows was impossible due to upstream bugs. While it may have become possible since then, it'll still provide significant challenges due to high technical complexity related to FFI, cgo and Windows-specific issues. -For Windows users, WSL will probably be the option for using `stackablectl`. +For Windows users, WSL will probably be the best option for using `stackablectl`. -If you do want to attempt compiling for Windows, please refer to xref:#building-from-source[this] section - and if you are successful, by -all means, give us a shout and we will reward you handsomely!! +If you do want to attempt compiling for Windows, please refer to xref:#building-from-source[this] section - and if you are successful, by all means, give us a shout and we will reward you handsomely! -- ====