Skip to content

Commit a78a49d

Browse files
authored
Merge pull request #50 from stackql/feature/updates
web updates
2 parents 175268b + 9778c98 commit a78a49d

3 files changed

Lines changed: 44 additions & 13 deletions

File tree

website/docs/getting-started.md

Lines changed: 37 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,12 @@ unlisted: false
1212
import File from '/src/components/File';
1313
import Tabs from '@theme/Tabs';
1414
import TabItem from '@theme/TabItem';
15+
import { FaApple, FaWindows, FaGithub, FaRust } from 'react-icons/fa';
16+
import { FcLinux } from 'react-icons/fc';
17+
18+
export const tabLabel = (icon, text) => (
19+
<span style={{ display: 'inline-flex', alignItems: 'center', gap: '0.4em' }}>{icon}{text}</span>
20+
);
1521

1622
`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).
1723

@@ -20,16 +26,26 @@ import TabItem from '@theme/TabItem';
2026
`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).
2127

2228
<Tabs>
23-
<TabItem value="linux-macos" label="Linux / macOS">
29+
<TabItem value="linux-macos" label={<span style={{ display: 'inline-flex', alignItems: 'center', gap: '0.4em' }}>{tabLabel(<FcLinux />, 'Linux')}/{tabLabel(<FaApple />, 'macOS')}</span>}>
30+
31+
The install script detects your OS and architecture and downloads the matching release binary into the current directory:
32+
33+
```bash
34+
curl -fsSL https://get-stackql-deploy.io/install.sh | sh
35+
```
2436

25-
The canonical install URL detects your OS and redirects to the latest release asset automatically:
37+
Test the install:
2638

2739
```bash
28-
curl -L https://get-stackql-deploy.io | tar xzf -
40+
# test from the current dir
41+
./stackql-deploy info
42+
# OPTIONAL: move into your PATH
2943
sudo mv stackql-deploy /usr/local/bin/
44+
stackql-deploy info
3045
```
3146

32-
Or download a specific platform build:
47+
<details>
48+
<summary>Download a specific platform build</summary>
3349

3450
**macOS Universal (Apple Silicon + Intel):**
3551

@@ -52,24 +68,31 @@ curl -L https://github.com/stackql/stackql-deploy-rs/releases/latest/download/st
5268
sudo mv stackql-deploy /usr/local/bin/
5369
```
5470

55-
</TabItem>
56-
<TabItem value="windows" label="Windows">
71+
</details>
5772

58-
**PowerShell:**
73+
</TabItem>
74+
<TabItem value="windows" label={tabLabel(<FaWindows style={{ color: '#00A4EF' }} />, 'Windows')}>
5975

6076
The install script downloads the latest release and extracts `stackql-deploy.exe` into the current directory:
6177

6278
```powershell
6379
irm https://get-stackql-deploy.io/install.ps1 | iex
6480
```
6581

66-
Then move it onto your PATH:
82+
Test the install:
6783

6884
```powershell
85+
# test from the current dir
86+
.\stackql-deploy.exe info
87+
# OPTIONAL: move onto your PATH
6988
Move-Item stackql-deploy.exe "$env:LOCALAPPDATA\Microsoft\WindowsApps\"
89+
stackql-deploy info
7090
```
7191

72-
Or do it manually:
92+
<details>
93+
<summary>Install manually, or via WSL / Git Bash</summary>
94+
95+
**Manual download (PowerShell):**
7396

7497
```powershell
7598
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
85108
unzip stackql-deploy.zip
86109
```
87110

111+
</details>
112+
88113
</TabItem>
89-
<TabItem value="github-releases" label="GitHub Releases">
114+
<TabItem value="github-releases" label={tabLabel(<FaGithub />, 'GitHub Releases')}>
90115

91116
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.
92117

@@ -98,7 +123,7 @@ Pre-built binaries are attached to every release on the [__GitHub Releases__](ht
98123
| Windows x86_64 | `stackql-deploy-windows-x86_64.zip` |
99124

100125
</TabItem>
101-
<TabItem value="github-actions" label="GitHub Actions">
126+
<TabItem value="github-actions" label={tabLabel(<FaGithub />, 'GitHub Actions')}>
102127

103128
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.
104129

@@ -137,7 +162,7 @@ steps:
137162
See [__Deploying with GitHub Actions__](/github-actions) for the full reference.
138163
139164
</TabItem>
140-
<TabItem value="cargo" label="Cargo (from source)">
165+
<TabItem value="cargo" label={tabLabel(<FaRust />, 'Cargo (from source)')}>
141166
142167
If you have the Rust toolchain installed (via [rustup](https://rustup.rs/)):
143168

website/package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@
2828
"clsx": "^2.0.0",
2929
"prism-react-renderer": "^2.3.1",
3030
"react": "^18.0.0",
31-
"react-dom": "^18.0.0"
31+
"react-dom": "^18.0.0",
32+
"react-icons": "^5.6.0"
3233
},
3334
"devDependencies": {
3435
"@docusaurus/module-type-aliases": "3.9.2",

website/yarn.lock

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10158,6 +10158,11 @@ react-fast-compare@^3.2.0:
1015810158
react-fast-compare "^3.2.0"
1015910159
shallowequal "^1.1.0"
1016010160

10161+
react-icons@^5.6.0:
10162+
version "5.6.0"
10163+
resolved "https://registry.yarnpkg.com/react-icons/-/react-icons-5.6.0.tgz#27bcc4acbc836e762548d76041cf9b9fef4e3837"
10164+
integrity sha512-RH93p5ki6LfOiIt0UtDyNg/cee+HLVR6cHHtW3wALfo+eOHTp8RnU2kRkI6E+H19zMIs03DyxUG/GfZMOGvmiA==
10165+
1016110166
react-is@^16.13.1, react-is@^16.6.0, react-is@^16.7.0:
1016210167
version "16.13.1"
1016310168
resolved "https://registry.yarnpkg.com/react-is/-/react-is-16.13.1.tgz#789729a4dc36de2999dc156dd6c1d9c18cea56a4"

0 commit comments

Comments
 (0)