From e31c00d72edfab91b6e487c4c6e8ba50dae5a23b Mon Sep 17 00:00:00 2001 From: Jeffrey Aven Date: Wed, 24 Jun 2026 11:20:16 +1000 Subject: [PATCH 1/4] Use install.sh one-liner for Linux/macOS in getting-started Aligns the Linux/macOS install with the Windows tab: both now lead with the install-endpoint one-liner (curl .../install.sh | sh) that downloads the binary into the current directory, followed by a separate move-onto-PATH step, instead of the older root-redirect curl | tar form. Co-Authored-By: Claude Opus 4.8 (1M context) --- website/docs/getting-started.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/website/docs/getting-started.md b/website/docs/getting-started.md index cc6032f..c53c9d1 100644 --- a/website/docs/getting-started.md +++ b/website/docs/getting-started.md @@ -22,10 +22,15 @@ import TabItem from '@theme/TabItem'; -The canonical install URL detects your OS and redirects to the latest release asset automatically: +The install script detects your OS and architecture and downloads the matching release binary into the current directory: + +```bash +curl -fsSL https://get-stackql-deploy.io/install.sh | sh +``` + +Then move it onto your PATH: ```bash -curl -L https://get-stackql-deploy.io | tar xzf - sudo mv stackql-deploy /usr/local/bin/ ``` From 9321ad7a5e6b66521f943a86a17d9c00dde2d8b3 Mon Sep 17 00:00:00 2001 From: Jeffrey Aven Date: Wed, 24 Jun 2026 11:25:47 +1000 Subject: [PATCH 2/4] Simplify install tabs: comment-driven test flow, collapse extras Both Linux/macOS and Windows install tabs now follow the same low-impedance shape: the one-liner install, a comment-driven "Test the install" block (run from the current dir, optional move onto PATH, run again), and the secondary per-platform / manual / WSL options tucked into a
pulldown. Co-Authored-By: Claude Opus 4.8 (1M context) --- website/docs/getting-started.md | 26 ++++++++++++++++++++------ 1 file changed, 20 insertions(+), 6 deletions(-) diff --git a/website/docs/getting-started.md b/website/docs/getting-started.md index c53c9d1..cb61233 100644 --- a/website/docs/getting-started.md +++ b/website/docs/getting-started.md @@ -28,13 +28,18 @@ The install script detects your OS and architecture and downloads the matching r curl -fsSL https://get-stackql-deploy.io/install.sh | sh ``` -Then move it onto your PATH: +Test the install: ```bash +# test from the current dir +./stackql-deploy info +# OPTIONAL: move into your PATH sudo mv stackql-deploy /usr/local/bin/ +stackql-deploy info ``` -Or download a specific platform build: +
+Download a specific platform build **macOS Universal (Apple Silicon + Intel):** @@ -57,24 +62,31 @@ curl -L https://github.com/stackql/stackql-deploy-rs/releases/latest/download/st sudo mv stackql-deploy /usr/local/bin/ ``` +
+ -**PowerShell:** - The install script downloads the latest release and extracts `stackql-deploy.exe` into the current directory: ```powershell irm https://get-stackql-deploy.io/install.ps1 | iex ``` -Then move it onto your PATH: +Test the install: ```powershell +# test from the current dir +.\stackql-deploy.exe info +# OPTIONAL: move onto your PATH Move-Item stackql-deploy.exe "$env:LOCALAPPDATA\Microsoft\WindowsApps\" +stackql-deploy info ``` -Or do it manually: +
+Install manually, or via WSL / Git Bash + +**Manual download (PowerShell):** ```powershell Invoke-WebRequest https://get-stackql-deploy.io -OutFile stackql-deploy.zip @@ -90,6 +102,8 @@ curl -L -o stackql-deploy.zip https://github.com/stackql/stackql-deploy-rs/relea unzip stackql-deploy.zip ``` +
+ From 4c3308477d67be8c7ce111c982f5c8a05a074481 Mon Sep 17 00:00:00 2001 From: Jeffrey Aven Date: Wed, 24 Jun 2026 11:52:09 +1000 Subject: [PATCH 3/4] Add vendor icons to install tab labels Snazz up the getting-started install tabs with vendor icons in the labels, matching the stackql.io installation page: Linux + Apple on the Linux/macOS tab, Windows, GitHub on the two GitHub tabs, and Rust on the Cargo tab. Adds react-icons and a small tabLabel helper. Verified with a full docusaurus build. Co-Authored-By: Claude Opus 4.8 (1M context) --- website/docs/getting-started.md | 16 +++++++++++----- website/package.json | 3 ++- website/yarn.lock | 5 +++++ 3 files changed, 18 insertions(+), 6 deletions(-) diff --git a/website/docs/getting-started.md b/website/docs/getting-started.md index cb61233..029c9b2 100644 --- a/website/docs/getting-started.md +++ b/website/docs/getting-started.md @@ -12,6 +12,12 @@ unlisted: false import File from '/src/components/File'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +import { FaApple, FaWindows, FaGithub, FaRust } from 'react-icons/fa'; +import { FcLinux } from 'react-icons/fc'; + +export const tabLabel = (icon, text) => ( + {icon}{text} +); `stackql-deploy` is a model driven, declarative framework for provisioning, de-provisioning and testing cloud resources. Heard enough and ready to get started? Jump to a [__Quick Start__](#quick-start). @@ -20,7 +26,7 @@ import TabItem from '@theme/TabItem'; `stackql-deploy` is distributed as a standalone binary with no runtime dependencies required. You can also download directly from your browser at [__get-stackql-deploy.io__](https://get-stackql-deploy.io). - +, 'Linux / macOS')}> The install script detects your OS and architecture and downloads the matching release binary into the current directory: @@ -65,7 +71,7 @@ sudo mv stackql-deploy /usr/local/bin/
- +, 'Windows')}> The install script downloads the latest release and extracts `stackql-deploy.exe` into the current directory: @@ -105,7 +111,7 @@ unzip stackql-deploy.zip - +, 'GitHub Releases')}> Pre-built binaries are attached to every release on the [__GitHub Releases__](https://github.com/stackql/stackql-deploy-rs/releases) page. A `SHA256SUMS` file is included for verification. @@ -117,7 +123,7 @@ Pre-built binaries are attached to every release on the [__GitHub Releases__](ht | Windows x86_64 | `stackql-deploy-windows-x86_64.zip` | - +, 'GitHub Actions')}> Use the [`stackql/setup-deploy`](https://github.com/marketplace/actions/stackql-deploy) action to install and run `stackql-deploy` in your CI/CD pipelines. The action automatically downloads the latest binary for the runner's platform. @@ -156,7 +162,7 @@ steps: See [__Deploying with GitHub Actions__](/github-actions) for the full reference. - +, 'Cargo (from source)')}> If you have the Rust toolchain installed (via [rustup](https://rustup.rs/)): diff --git a/website/package.json b/website/package.json index 77a241f..828e7ec 100644 --- a/website/package.json +++ b/website/package.json @@ -28,7 +28,8 @@ "clsx": "^2.0.0", "prism-react-renderer": "^2.3.1", "react": "^18.0.0", - "react-dom": "^18.0.0" + "react-dom": "^18.0.0", + "react-icons": "^5.6.0" }, "devDependencies": { "@docusaurus/module-type-aliases": "3.9.2", diff --git a/website/yarn.lock b/website/yarn.lock index f719779..723a199 100644 --- a/website/yarn.lock +++ b/website/yarn.lock @@ -10158,6 +10158,11 @@ react-fast-compare@^3.2.0: react-fast-compare "^3.2.0" shallowequal "^1.1.0" +react-icons@^5.6.0: + version "5.6.0" + resolved "https://registry.yarnpkg.com/react-icons/-/react-icons-5.6.0.tgz#27bcc4acbc836e762548d76041cf9b9fef4e3837" + integrity sha512-RH93p5ki6LfOiIt0UtDyNg/cee+HLVR6cHHtW3wALfo+eOHTp8RnU2kRkI6E+H19zMIs03DyxUG/GfZMOGvmiA== + react-is@^16.13.1, react-is@^16.6.0, react-is@^16.7.0: version "16.13.1" resolved "https://registry.yarnpkg.com/react-is/-/react-is-16.13.1.tgz#789729a4dc36de2999dc156dd6c1d9c18cea56a4" From 9778c9807acd23978acf186d0ea58bb861bd9381 Mon Sep 17 00:00:00 2001 From: Jeffrey Aven Date: Wed, 24 Jun 2026 12:03:19 +1000 Subject: [PATCH 4/4] Pair each OS icon with its name in Linux/macOS tab Render the combined tab as "[Tux] Linux / [Apple] macOS" so each icon sits next to its own OS name, instead of both icons stacked before the text. Co-Authored-By: Claude Opus 4.8 (1M context) --- website/docs/getting-started.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/getting-started.md b/website/docs/getting-started.md index 029c9b2..3d4a6e0 100644 --- a/website/docs/getting-started.md +++ b/website/docs/getting-started.md @@ -26,7 +26,7 @@ export const tabLabel = (icon, text) => ( `stackql-deploy` is distributed as a standalone binary with no runtime dependencies required. You can also download directly from your browser at [__get-stackql-deploy.io__](https://get-stackql-deploy.io). -, 'Linux / macOS')}> +{tabLabel(, 'Linux')}/{tabLabel(, 'macOS')}}> The install script detects your OS and architecture and downloads the matching release binary into the current directory: