From 93fcb8a2c568528b709a1c6c314d02f014fdfb1b Mon Sep 17 00:00:00 2001
From: rzmk <30333942+rzmk@users.noreply.github.com>
Date: Wed, 15 Oct 2025 13:24:11 -0400
Subject: [PATCH] ui(docs): add steps component and WIP WSL reference page
---
docs/components/steps.tsx | 9 ++
docs/content/docs/index.mdx | 26 ++++-
.../docs/reference/developing-with-wsl.mdx | 95 +++++++++++++++++++
docs/content/docs/reference/meta.json | 6 ++
4 files changed, 132 insertions(+), 4 deletions(-)
create mode 100644 docs/components/steps.tsx
create mode 100644 docs/content/docs/reference/developing-with-wsl.mdx
create mode 100644 docs/content/docs/reference/meta.json
diff --git a/docs/components/steps.tsx b/docs/components/steps.tsx
new file mode 100644
index 0000000..ce348a2
--- /dev/null
+++ b/docs/components/steps.tsx
@@ -0,0 +1,9 @@
+import type { ReactNode } from 'react';
+
+export function Steps({ children }: { children: ReactNode }) {
+ return {children}
;
+}
+
+export function Step({ children }: { children: ReactNode }) {
+ return {children}
;
+}
diff --git a/docs/content/docs/index.mdx b/docs/content/docs/index.mdx
index d6f550b..649b0c3 100644
--- a/docs/content/docs/index.mdx
+++ b/docs/content/docs/index.mdx
@@ -17,9 +17,16 @@ import { Accordion, Accordions } from 'fumadocs-ui/components/accordion';
---
-You have several options to choose from for installation. Here are a few:
+## Install CKAN using ckan-devstaller
-## [1/3] Customize your CKAN installation with the Builder (Recommended)
+You have several options to choose from for installation. Here are a few you may choose one from:
+
+import { Step, Steps } from 'fumadocs-ui/components/steps';
+
+
+
+
+### Customize your CKAN installation with the Builder (Recommended)
}
@@ -29,7 +36,11 @@ You have several options to choose from for installation. Here are a few:
Click here to customize your CKAN installation with an interactive web GUI
-## [2/3] Install the "CKAN-only" preset
+
+
+
+
+### Install the "CKAN-only" preset
By running the following script, ckan-devstaller will be downloaded and the default configuration for installing CKAN 2.11.3 with ckan-compose will be selected. You can then customize your configuration interactively in your terminal after running this script.
@@ -43,7 +54,11 @@ If you'd rather skip the interactivity and go straight to installation, then run
wget -O - https://github.com/dathere/ckan-devstaller/releases/download/0.3.0/install.bash | bash -s skip-interactive
```
-## [3/3] Install the "datHere Default" preset
+
+
+
+
+### Install the "datHere Default" preset
The following script will download ckan-devstaller and select the following configuration:
@@ -67,6 +82,9 @@ If you'd rather skip the interactivity and go straight to installation, then run
wget -O - https://github.com/dathere/ckan-devstaller/releases/download/0.3.0/install.bash | bash -s dathere-default skip-interactive
```
+
+
+
## Learn more
import { BlocksIcon, HomeIcon, GitMergeIcon, Trash2Icon } from 'lucide-react';
diff --git a/docs/content/docs/reference/developing-with-wsl.mdx b/docs/content/docs/reference/developing-with-wsl.mdx
new file mode 100644
index 0000000..16956f2
--- /dev/null
+++ b/docs/content/docs/reference/developing-with-wsl.mdx
@@ -0,0 +1,95 @@
+---
+title: Developing with WSL
+description: Tips on how to develop ckan-devstaller on a Windows machine by leveraging Windows Subsystem for Linux.
+---
+
+
+ This page is a work in progress and is not intended to be used yet.
+
+
+When developing ckan-devstaller on Windows, using Windows Subsystem for Linux (WSL) can be advantageous to demo an Ubuntu 22.04 environment without having to set up a virtual machine.
+
+import { Step, Steps } from 'fumadocs-ui/components/steps';
+import { File, Folder, Files } from 'fumadocs-ui/components/files';
+
+
+
+
+### Install the Ubuntu-22.04 distribution
+
+You'll need to have the Ubuntu-22.04 distribution installed by running the following command:
+
+```bash
+wsl --install Ubuntu-22.04 --version 2
+```
+
+
+
+
+
+### Export a base image
+
+
+
+
+Here's the expected set up where we create a WSL folder:
+
+```files
+/c/Users/rzmk/WSL
+├── images
+| ├── ubuntu-22-04-snapshot.tar
+├── instances
+| ├── cdr.vdhx
+```
+
+Now try to access your new Ubuntu 22.04 instance `cdr` as the `root` user by running:
+
+```bash
+wsl -d cdr
+```
+
+Once logged in as `root`, you'll want to edit the `/etc/wsl.conf` file and modify it so you can login as an admin user instead of `root`. We can use the `nano` editor to modify the file:
+
+```bash
+nano /etc/wsl.conf
+```
+
+Modify the file by adding a `[user]` section with the value `default=rzmk` (where `rzmk` is your username). The file should look similar to this:
+
+```ini
+[boot]
+systemd=true
+
+[user]
+default=rzmk
+```
+
+Now leave your instance:
+
+```bash
+exit
+```
+
+Then terminate the instance:
+
+```bash
+wsl --terminate cdr
+```
+
+Run the instance again and you should be logged in as your admin user by default now:
+
+```bash
+wsl -d cdr
+```
+
+Great, now you can go to the home directory and run one of the [quick start](/docs) scripts:
+
+```bash
+cd ~/
+```
+
+When you want to remove your instance (e.g. so that you can start a brand new instance) then run the following to unregister it:
+
+```bash
+wsl --unregister cdr
+```
diff --git a/docs/content/docs/reference/meta.json b/docs/content/docs/reference/meta.json
new file mode 100644
index 0000000..3cbd321
--- /dev/null
+++ b/docs/content/docs/reference/meta.json
@@ -0,0 +1,6 @@
+{
+ "pages": [
+ "...",
+ "!developing-with-wsl"
+ ]
+}
\ No newline at end of file