From 65aff22b992829a1bab9055f8b8809d67bfd4030 Mon Sep 17 00:00:00 2001 From: rzmk <30333942+rzmk@users.noreply.github.com> Date: Tue, 14 Oct 2025 05:47:11 -0400 Subject: [PATCH] feat(docs): add options to quick-start, update home page, disable what-is for now --- docs/app/(home)/page.tsx | 59 +++++++++++++++++++------------------ docs/content/docs/index.mdx | 42 +++++++++++++++++++++----- docs/content/docs/meta.json | 9 +++++- 3 files changed, 73 insertions(+), 37 deletions(-) diff --git a/docs/app/(home)/page.tsx b/docs/app/(home)/page.tsx index 5598564..63885c7 100644 --- a/docs/app/(home)/page.tsx +++ b/docs/app/(home)/page.tsx @@ -38,33 +38,6 @@ export default function HomePage() {
- - } - href="/docs/quick-start" - title="Quick start" - > - Get started with ckan-devstaller and install CKAN within minutes - - } href="/docs/builder" title="Builder"> - Customize your installation with an interactive web GUI - - } - href="/docs/reference/installation-architecture" - title="Installation architecture" - > - Learn about where files are installed after running - ckan-devstaller - - } - href="https://github.com/dathere/ckan-devstaller" - title="Source code" - > - View the source code of ckan-devstaller on GitHub - - @@ -72,6 +45,7 @@ export default function HomePage() { } function Hero() { + const { Card, Cards } = defaultMdxComponents; return (
.

-
+
+ + } + href="/docs/quick-start" + title="Quick start" + > + Get started with ckan-devstaller and install CKAN within minutes + + } href="/docs/builder" title="Builder"> + Customize your installation with an interactive web GUI + + } + href="/docs/reference/installation-architecture" + title="Installation architecture" + > + Learn about where files are installed after running + ckan-devstaller + + } + href="https://github.com/dathere/ckan-devstaller" + title="Source code" + > + View the source code of ckan-devstaller on GitHub + +
); @@ -149,7 +150,7 @@ function PreviewImages() { ]; return ( -
+
{/*
Currently `ckan-devstaller` supports `x86_64` architecture. `ARM64` support is planned. -Currently you have two options to choose from for installation. Paste one of the following scripts into your new Ubuntu 22.04 instance's terminal: +--- -## (Option 1/2) Install with interactive mode +You have several options to choose from for installation. Here are a few: + +## [1/3] Customize your CKAN installation with the Builder (Recommended) + +} + href="/docs/builder" + title="Builder" + > + Click here to customize your CKAN installation with an interactive web GUI + + +## [2/3] 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. ```bash -wget -O - https://github.com/dathere/ckan-devstaller/releases/download/0.2.1/install.bash | bash -s default +wget -O - https://github.com/dathere/ckan-devstaller/releases/download/0.3.0/install.bash | bash ``` -## (Option 2/2) Install with non-interactive mode with a specific config +If you'd rather skip the interactivity and go straight to installation, then run the following script instead: -The following script will install the following: +```bash +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 + +The following script will download ckan-devstaller and select the following configuration: - CKAN 2.11.3 - [ckan-compose](https://github.com/tino097/ckan-compose/tree/ckan-devstaller) - [DataStore extension](https://docs.ckan.org/en/2.11/maintaining/datastore.html) - [ckanext-scheming extension](https://github.com/ckan/ckanext-scheming) - [DataPusher+ extension](https://github.com/dathere/datapusher-plus) +- Install the `openssh-server` package for allowing SSH capability +- [DRUF mode](https://github.com/dathere/datapusher-plus?tab=readme-ov-file#druf-dataset-resource-upload-first-workflow) for DataPusher+ is available but disabled by default. -[DRUF mode](https://github.com/dathere/datapusher-plus?tab=readme-ov-file#druf-dataset-resource-upload-first-workflow) for DataPusher+ is available but disabled by default. +You can then customize your configuration interactively in your terminal after running this script. ```bash -wget -O - https://github.com/dathere/ckan-devstaller/releases/download/0.2.1/install.bash | bash -s default +wget -O - https://github.com/dathere/ckan-devstaller/releases/download/0.3.0/install.bash | bash -s dathere-default +``` + +If you'd rather skip the interactivity and go straight to installation, then run the following script instead: + +```bash +wget -O - https://github.com/dathere/ckan-devstaller/releases/download/0.3.0/install.bash | bash -s dathere-default skip-interactive ``` ## Learn more diff --git a/docs/content/docs/meta.json b/docs/content/docs/meta.json index ead60d0..71c5117 100644 --- a/docs/content/docs/meta.json +++ b/docs/content/docs/meta.json @@ -1,3 +1,10 @@ { - "pages": ["---Introduction---", "index", "what-is-ckan-devstaller", "builder", "---Further reading---", "tutorials", "reference"] + "pages": [ + "---Introduction---", + "index", + "builder", + "---Further reading---", + "tutorials", + "reference" + ] } \ No newline at end of file