diff --git a/website/docs/getting-started.md b/website/docs/getting-started.md index cc6032f..3d4a6e0 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,16 +26,26 @@ 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). - +{tabLabel(, 'Linux')}/{tabLabel(, 'macOS')}}> + +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 +``` -The canonical install URL detects your OS and redirects to the latest release asset automatically: +Test the install: ```bash -curl -L https://get-stackql-deploy.io | tar xzf - +# 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):** @@ -52,10 +68,10 @@ curl -L https://github.com/stackql/stackql-deploy-rs/releases/latest/download/st sudo mv stackql-deploy /usr/local/bin/ ``` - - +
-**PowerShell:** +
+, 'Windows')}> The install script downloads the latest release and extracts `stackql-deploy.exe` into the current directory: @@ -63,13 +79,20 @@ The install script downloads the latest release and extracts `stackql-deploy.exe 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 @@ -85,8 +108,10 @@ curl -L -o stackql-deploy.zip https://github.com/stackql/stackql-deploy-rs/relea 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. @@ -98,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. @@ -137,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"