mirror of
https://github.com/dathere/ckan-devstaller.git
synced 2025-11-09 13:39:49 +00:00
feat(docs): add options to quick-start, update home page, disable what-is for now
This commit is contained in:
rzmk
parent
1c0f3c2e15
commit
65aff22b99
3 changed files with 73 additions and 37 deletions
|
|
@ -38,33 +38,6 @@ export default function HomePage() {
|
|||
<div className="relative mb-4">
|
||||
<Hero />
|
||||
</div>
|
||||
<Cards>
|
||||
<Card
|
||||
icon={<ZapIcon />}
|
||||
href="/docs/quick-start"
|
||||
title="Quick start"
|
||||
>
|
||||
Get started with ckan-devstaller and install CKAN within minutes
|
||||
</Card>
|
||||
<Card icon={<BlocksIcon />} href="/docs/builder" title="Builder">
|
||||
Customize your installation with an interactive web GUI
|
||||
</Card>
|
||||
<Card
|
||||
icon={<HomeIcon />}
|
||||
href="/docs/reference/installation-architecture"
|
||||
title="Installation architecture"
|
||||
>
|
||||
Learn about where files are installed after running
|
||||
ckan-devstaller
|
||||
</Card>
|
||||
<Card
|
||||
icon={<GitMergeIcon />}
|
||||
href="https://github.com/dathere/ckan-devstaller"
|
||||
title="Source code"
|
||||
>
|
||||
View the source code of ckan-devstaller on GitHub
|
||||
</Card>
|
||||
</Cards>
|
||||
</div>
|
||||
</main>
|
||||
</>
|
||||
|
|
@ -72,6 +45,7 @@ export default function HomePage() {
|
|||
}
|
||||
|
||||
function Hero() {
|
||||
const { Card, Cards } = defaultMdxComponents;
|
||||
return (
|
||||
<div className="relative z-2 flex flex-col border-x border-t bg-fd-background/80 px-4 pt-12 max-md:text-center md:px-12 md:pt-16 [.uwu_&]:hidden overflow-hidden">
|
||||
<div
|
||||
|
|
@ -112,7 +86,7 @@ function Hero() {
|
|||
</Link>
|
||||
.
|
||||
</p>
|
||||
<div className="inline-flex items-center gap-3 max-md:mx-auto">
|
||||
<div className="inline-flex items-center gap-3 max-md:mx-auto mb-8">
|
||||
<Link
|
||||
href="/docs"
|
||||
className={cn(
|
||||
|
|
@ -134,6 +108,33 @@ function Hero() {
|
|||
Source Code
|
||||
</Link>
|
||||
</div>
|
||||
<Cards>
|
||||
<Card
|
||||
icon={<ZapIcon />}
|
||||
href="/docs/quick-start"
|
||||
title="Quick start"
|
||||
>
|
||||
Get started with ckan-devstaller and install CKAN within minutes
|
||||
</Card>
|
||||
<Card icon={<BlocksIcon />} href="/docs/builder" title="Builder">
|
||||
Customize your installation with an interactive web GUI
|
||||
</Card>
|
||||
<Card
|
||||
icon={<HomeIcon />}
|
||||
href="/docs/reference/installation-architecture"
|
||||
title="Installation architecture"
|
||||
>
|
||||
Learn about where files are installed after running
|
||||
ckan-devstaller
|
||||
</Card>
|
||||
<Card
|
||||
icon={<GitMergeIcon />}
|
||||
href="https://github.com/dathere/ckan-devstaller"
|
||||
title="Source code"
|
||||
>
|
||||
View the source code of ckan-devstaller on GitHub
|
||||
</Card>
|
||||
</Cards>
|
||||
<PreviewImages />
|
||||
</div>
|
||||
);
|
||||
|
|
@ -149,7 +150,7 @@ function PreviewImages() {
|
|||
];
|
||||
|
||||
return (
|
||||
<div className="mt-12 p-8 min-w-[800px] overflow-hidden xl:-mx-12 dark:[mask-image:linear-gradient(to_top,transparent,white_40px)]">
|
||||
<div className="p-8 min-w-[800px] overflow-hidden xl:-mx-12 dark:[mask-image:linear-gradient(to_top,transparent,white_40px)]">
|
||||
<div className="absolute flex flex-row left-1/2 -translate-1/2 bottom-4 z-2 p-1 rounded-full bg-fd-card border shadow-xl dark:shadow-fd-background">
|
||||
{/* <div
|
||||
role="none"
|
||||
|
|
|
|||
|
|
@ -15,28 +15,56 @@ import { Accordion, Accordions } from 'fumadocs-ui/components/accordion';
|
|||
<Accordion title="Note for ARM64 users">Currently `ckan-devstaller` supports `x86_64` architecture. `ARM64` support is planned.</Accordion>
|
||||
</Accordions>
|
||||
|
||||
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)
|
||||
|
||||
<Card
|
||||
icon={<BlocksIcon />}
|
||||
href="/docs/builder"
|
||||
title="Builder"
|
||||
>
|
||||
Click here to customize your CKAN installation with an interactive web GUI
|
||||
</Card>
|
||||
|
||||
## [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
|
||||
|
|
|
|||
|
|
@ -1,3 +1,10 @@
|
|||
{
|
||||
"pages": ["---Introduction---", "index", "what-is-ckan-devstaller", "builder", "---Further reading---", "tutorials", "reference"]
|
||||
"pages": [
|
||||
"---Introduction---",
|
||||
"index",
|
||||
"builder",
|
||||
"---Further reading---",
|
||||
"tutorials",
|
||||
"reference"
|
||||
]
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue