Skip to content

Commit 5905878

Browse files
Zorlinclaude
andcommitted
Fix broken links, correct GitHub URLs, and flesh out docs
- Fix card links on Dragonfly and Jetpack intro pages (replace non-existent "production deployment" paths with real targets or about:blank for unimplemented features) - Correct GitHub org from dragonflycomputer to riffcc in installation pages - Rewrite docs index with proper feature cards and links - Add component descriptions for Mage, Spark, and Jetpack - Fix Mage page (was copy-pasted Spark description) - Expand perform-maintenance guide with Spark advanced menu - Mention Mage and Jetpack in introduction alongside Spark 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 8baa75b commit 5905878

11 files changed

Lines changed: 82 additions & 42 deletions

File tree

content/docs/_index.md

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -11,26 +11,24 @@ Welcome to Dragonfly.
1111

1212
Dragonfly is a powerful *metal management* platform that simplifies the deployment and management of operating systems and software across your infrastructure.
1313

14-
It consists of two main components: Dragonfly and Jetpack.
15-
1614
<hr>
1715
{{< hextra/feature-grid >}}
16+
{{< hextra/feature-card
17+
title="Learn more"
18+
subtitle="Get to know Dragonfly. Deploy operating systems across your infrastructure with ease."
19+
link="/docs/introduction/dragonfly/"
20+
icon="arrow-circle-right"
21+
>}}
1822
{{< hextra/feature-card
1923
title="Quick Start"
20-
subtitle="Bare metal provisioning and PXE boot management. Deploy operating systems across your infrastructure with ease."
21-
link="quick-start"
22-
icon="server"
24+
subtitle="Get started with Dragonfly in minutes. Guides for Linux, macOS and Docker."
25+
link="/docs/installation/quick-start/"
26+
icon="cloud-download"
27+
>}}
28+
{{< hextra/feature-card
29+
title="Docker & Kubernetes"
30+
subtitle="Instructions for installing and deploying Dragonfly on Docker or Kubernetes."
31+
link="/docs/installation/"
32+
icon="trending-up"
2333
>}}
24-
{{< hextra/feature-card
25-
title="Install"
26-
subtitle="Bare metal provisioning and PXE boot management. Deploy operating systems across your infrastructure with ease."
27-
link="dragonfly"
28-
icon="server"
29-
>}}
30-
{{< hextra/feature-card
31-
title="Docker & Kubernetes"
32-
subtitle="Instructions for installing and deploying Dragonfly on Docker or Kubernetes."
33-
link="jetpack"
34-
icon="chip"
35-
>}}
3634
{{< /hextra/feature-grid >}}

content/docs/components/_index.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,25 @@ weight: 7
66
sidebar:
77
open: true
88
---
9-
Spark documentation coming soon.
9+
10+
Dragonfly consists of various vertically integrated open source tools.
11+
12+
<p></p>
13+
{{< hextra/feature-grid >}}
14+
{{< hextra/feature-card
15+
title="Jetpack"
16+
subtitle="Next-generation configuration management. A modern approach to infrastructure automation that learns from Ansible's lessons."
17+
link="/docs/introduction/jetpack/"
18+
icon="chip"
19+
>}}
20+
{{< hextra/feature-card
21+
title="Mage"
22+
subtitle="Our operating system flashing framework. Images machines in under 90 seconds."
23+
icon="status-online"
24+
>}}
25+
{{< hextra/feature-card
26+
title="Spark"
27+
subtitle="Allows for remote management of devices and machines, including provisioning, monitoring, and troubleshooting."
28+
icon="lightning-bolt"
29+
>}}
30+
{{< /hextra/feature-grid >}}

content/docs/components/mage.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ weight: 1
66
sidebar:
77
open: true
88
---
9-
Spark is a powerful PXE boot agent that allows you to enable remote management of your entire network.
9+
Mage is our custom imaging agent.
1010

11-
You can enable Spark on a machine by simply enabling boot-to-network as your default boot option on any machine on a network with a running Dragonfly deployment.
11+
It consists of a small Rust binary called `dragonfly-agent` and wrappers around Alpine Linux.
12+
13+
More information coming soon in Dragonfly v0.2.0.

content/docs/components/spark.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,5 @@ sidebar:
99
Spark is a powerful PXE boot agent that allows you to enable remote management of your entire network.
1010

1111
You can enable Spark on a machine by simply enabling boot-to-network as your default boot option on any machine on a network with a running Dragonfly deployment.
12+
13+
More information coming soon in Dragonfly v0.2.0.

content/docs/installation/_index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,4 +36,6 @@ As soon as Dragonfly is up and running, you can use it to manage your computers.
3636

3737
The Spark agent allows you to perform basic maintenance tasks remotely or locally.
3838

39+
Enable PXE/Network booting on each computer you want to manage with Spark.
40+
3941
{{% /steps %}}

content/docs/installation/native.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ sidebar:
77
open: true
88
next: /docs/installation/production-setup/
99
---
10-
Download the latest binary from the [releases page](https://github.com/dragonflycomputer/dragonfly/releases).
10+
Download the latest binary from the [releases page](https://github.com/riffcc/dragonfly/releases).
1111

1212
You'll want the version for your computer.
1313

@@ -16,7 +16,7 @@ You'll want the version for your computer.
1616
{{< tab >}}
1717
Download Dragonfly from the [releases page](https://github.com/riffcc/dragonfly/releases).
1818
```
19-
wget -O dragonfly https://github.com/dragonflycomputer/dragonfly/releases/download/v0.1.0-alpha1/dragonfly-linux-amd64
19+
wget -O dragonfly https://github.com/riffcc/dragonfly/releases/download/v0.1.0-alpha1/dragonfly-linux-amd64
2020
```
2121

2222
Copy the binary to /usr/local/bin/dragonfly and make it executable:
@@ -37,7 +37,7 @@ You'll want the version for your computer.
3737
{{< tab >}}
3838
Download Dragonfly from the [releases page](https://github.com/riffcc/dragonfly/releases).
3939
```
40-
wget -O dragonfly https://github.com/dragonflycomputer/dragonfly/releases/download/v0.1.0-alpha1/dragonfly-darwin-amd64
40+
wget -O dragonfly https://github.com/riffcc/dragonfly/releases/download/v0.1.0-alpha1/dragonfly-darwin-amd64
4141
```
4242

4343
Copy the binary to /usr/local/bin/dragonfly and make it executable:

content/docs/installation/quick-start.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,13 @@ Edit it to your needs, then run
3131
docker-compose up -d
3232
```
3333

34-
Visit the web interface at http://localhost:3000
34+
Visit the web interface at `http://localhost:3000`
3535
(or `http://your-hostname:3000` if you're not running it locally)
3636

37-
For more details on running Dragonfly with Docker, see the [Docker guide](/docs/docker).
37+
For more details on running Dragonfly with Docker, see the [Docker guide](/docs/installation/docker).
3838

3939
### Binary Installation
40-
Download the latest binary from the [releases page](https://github.com/dragonflycomputer/dragonfly/releases).
40+
Download the latest binary from the [releases page](https://github.com/riffcc/dragonfly/releases).
4141

4242
You'll want the version for your computer.
4343

@@ -46,7 +46,7 @@ You'll want the version for your computer.
4646
{{< tab >}}
4747
Download Dragonfly from the [releases page](https://github.com/riffcc/dragonfly/releases).
4848
```
49-
wget -O dragonfly https://github.com/dragonflycomputer/dragonfly/releases/download/v0.1.0-alpha1/dragonfly-linux-amd64
49+
wget -O dragonfly https://github.com/riffcc/dragonfly/releases/download/v0.1.0-alpha1/dragonfly-linux-amd64
5050
```
5151

5252
Copy the binary to /usr/local/bin/dragonfly and make it executable:
@@ -65,9 +65,12 @@ You'll want the version for your computer.
6565
{{< /tab >}}
6666
<!-- macOS -->
6767
{{< tab >}}
68+
macOS installation relies on installing Dragonfly as a native binary.
69+
Future releases will include Homebrew support.
70+
6871
Download Dragonfly from the [releases page](https://github.com/riffcc/dragonfly/releases).
6972
```
70-
wget -O dragonfly https://github.com/dragonflycomputer/dragonfly/releases/download/v0.1.0-alpha1/dragonfly-darwin-amd64
73+
wget -O dragonfly https://github.com/riffcc/dragonfly/releases/download/v0.1.0-alpha1/dragonfly-darwin-amd64
7174
```
7275

7376
Copy the binary to /usr/local/bin/dragonfly and make it executable:

content/docs/introduction/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,4 @@ This means you can take a computer out of the box, network boot it, and be runni
1717

1818
<img src="/images/screenshots/spark-install-os.png" alt="Dragonfly Machines Dashboard" style="width: 75%; border-radius: 0.5rem; box-shadow: 0 20px 25px -5px rgb(0 0 0 / 0.1), 0 8px 10px -6px rgb(0 0 0 / 0.1);" />
1919

20-
Dragonfly also provides [Spark](/docs/components/spark/), a lightweight, distributed agent that can optionally be used to manage your computers and perform monitoring and management tasks.
20+
Dragonfly also provides [Spark](/docs/components/spark/), a lightweight, distributed agent that can optionally be used to manage your computers and perform monitoring and management tasks; [Mage](/docs/components/mage/) for flashing operating systems; and [Jetpack](/docs/introduction/jetpack/), an Infrastructure as Code tool for managing arbitrary infrastructure.

content/docs/introduction/dragonfly.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,14 @@ You can use Dragonfly to install and manage Linux, as well as remotely reinstall
1616
{{< cards >}}
1717
{{< card link="/docs/usage/deploying-with-dragonfly" title="Deploy Linux in under 90 seconds" subtitle="Dragonfly deploys - fast. Bring up a machine all the way to SSH in 90 seconds or less."icon="hard-drive-download" >}}
1818
{{< card link="/docs/usage-jetpack/apply-updates" title="Apply updates across your fleet" subtitle="Keep your fleet up to date with automatic updates and security patches (coming soon)." icon="shield-check" >}}
19-
{{< card link="production deployment" title="Perform maintenance tasks" subtitle="Remotely reinstall, wipe, diagnose, and repair - even on machines lacking IPMI/BMC devices." icon="hammer" >}}
20-
{{< card link="production deployment" title="Boot to ISO" subtitle="Remotely reinstall, wipe, diagnose, and repair - even on machines lacking IPMI/BMC devices." icon="disc-2" >}}
21-
{{< card link="production deployment" title="Manage from anywhere" subtitle="Designed for secure management from anywhere, Dragonfly gives you freedom and flexibility." icon="globe" >}}
22-
{{< card link="dhcp" title="Coexists with existing infrastructure" subtitle="Dragonfly can coexist with existing DHCP servers, ensuring easy rollout and configuration." icon="handshake" >}}
19+
{{< card link="/docs/usage/perform-maintenance/" title="Perform maintenance tasks" subtitle="Remotely reinstall, wipe, diagnose, and repair - even on machines lacking IPMI/BMC devices." icon="hammer" >}}
20+
{{< card link="/docs/usage/managing-iso-images/" title="Boot to ISO" subtitle="Remotely reinstall, wipe, diagnose, and repair - even on machines lacking IPMI/BMC devices." icon="disc-2" >}}
21+
{{< card link="about:blank" title="Manage from anywhere" subtitle="Designed for secure management from anywhere, Dragonfly gives you freedom and flexibility." icon="globe" >}}
22+
{{< card link="about:blank" title="Coexists with existing infrastructure" subtitle="Dragonfly can coexist with existing DHCP servers, ensuring easy rollout and configuration." icon="handshake" >}}
2323
<!--
2424
{{< card link="multi region deployment" title="Multi-region deployment" icon="earth" >}}
2525
-->
26-
{{< card link="kubernetes" title="Flexible deployment options" subtitle="Designed to run on everything from your laptop to entire data centers" icon="kubernetes" >}}
27-
{{< card link="production deployment" title="Rich power controls" subtitle="Integrates with your favourite IPMI/BMC solutions - and Home Assistant and Proxmox (coming soon)" icon="power" >}}
28-
{{< card link="multitenancy" title="Multi-tenancy" subtitle="Dragonfly supports multi-tenancy, allowing you to manage multiple environments from a single instance." icon="users" >}}
26+
{{< card link="/docs/installation/" title="Flexible deployment options" subtitle="Designed to run on everything from your laptop to entire data centers" icon="kubernetes" >}}
27+
{{< card link="about:blank" title="Rich power controls" subtitle="Integrates with your favourite IPMI/BMC solutions - and Home Assistant and Proxmox (coming soon)" icon="power" >}}
28+
{{< card link="about:blank" title="Multi-tenancy" subtitle="Dragonfly supports multi-tenancy, allowing you to manage multiple environments from a single instance." icon="users" >}}
2929
{{< /cards >}}

content/docs/introduction/jetpack.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@ It combines functionality seen in tools such as Ansible and Terraform, providing
1515
Jetpack is based on the Jetporch project by Jetporch contributors including Michael DeHaan.
1616

1717
{{< cards >}}
18-
{{< card link="powerful" title="Powerful and flexible" subtitle="Jetpack comes with all of the scripting capabilities you expect, including some you might not." icon="biceps-flexed" >}}
19-
{{< card link="update" title="AI Native" subtitle="Built-in optional AI capabilities and integrations allow you to automate and optimize your infrastructure." icon="bot" >}}
18+
{{< card link="about:blank" title="Powerful and flexible" subtitle="Jetpack comes with all of the scripting capabilities you expect, including some you might not." icon="biceps-flexed" >}}
19+
{{< card link="about:blank" title="AI Native" subtitle="Built-in optional AI capabilities and integrations allow you to automate and optimize your infrastructure." icon="bot" >}}
2020
{{< card link="https://github.com/riffcc/jetpack" title="Open source" subtitle="Jetpack is open source and licensed under the GNU GPLv3." icon="copyleft" >}}
21-
{{< card link="production deployment" title="Instantiate" subtitle="Need to deploy a database cluster? Jetpack will create the necessary infrastructure for you." icon="bow-arrow" >}}
22-
{{< card link="production deployment" title="Rollback (coming soon)" subtitle="Undo rollouts and changes quickly." icon="undo-dot" >}}
23-
{{< card link="production deployment" title="Fast" subtitle="Built for speed and scale, Jetpack is designed to handle large-scale deployments quickly and efficiently." icon="rabbit" >}}
21+
{{< card link="about:blank" title="Instantiate" subtitle="Need to deploy a database cluster? Jetpack will create the necessary infrastructure for you." icon="bow-arrow" >}}
22+
{{< card link="about:blank" title="Rollback (coming soon)" subtitle="Undo rollouts and changes quickly." icon="undo-dot" >}}
23+
{{< card link="about:blank" title="Fast" subtitle="Built for speed and scale, Jetpack is designed to handle large-scale deployments quickly and efficiently." icon="rabbit" >}}
2424
{{< /cards >}}

0 commit comments

Comments
 (0)