Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions STYLE.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ RUSTFS_VOLUMES="/data"
- Plain Markdown pages use `.md`.
- Pages that need JSX components (`<Cards>`, `<Tabs>`, `<Steps>`, etc.) must use the `.mdx` extension. Do not put JSX in `.md` files.
- Mermaid diagrams are supported in fenced ```mermaid blocks.
- **Card icons:** when a landing grid (`<Cards>`) uses icons, use a single consistent set of monochrome line icons from `lucide-react` (registered in `press.config.tsx`), one semantically matched icon per card, applied to **every** card in the grid — never a partial set. Do not use emoji-as-icons and do not mix brand logos (e.g. the Docker whale) with abstract icons. Pass them via `<Card icon={<Rocket />} …>`.

## Product Terminology

Expand Down
22 changes: 11 additions & 11 deletions content/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ RustFS is a high-performance, distributed object storage system written in Rust,
## Try RustFS in 10 minutes

<Cards>
<Card title="Quick Start" href="/installation/linux/quick-start">
<Card icon={<Rocket />} title="Quick Start" href="/installation/linux/quick-start">
One command to install, log in to the Console, and store your first object.
</Card>
<Card title="Run with Docker" href="/installation/docker">
<Card icon={<Container />} title="Run with Docker" href="/installation/docker">
A single `docker run` for local evaluation — no server required.
</Card>
</Cards>
Expand All @@ -21,41 +21,41 @@ RustFS is a high-performance, distributed object storage system written in Rust,
### Evaluating RustFS?

<Cards>
<Card title="What is RustFS?" href="/concepts/introduction">
<Card icon={<BookOpen />} title="What is RustFS?" href="/concepts/introduction">
Positioning, features, and license.
</Card>
<Card title="Architecture & Comparison" href="/concepts/architecture">
<Card icon={<Network />} title="Architecture & Comparison" href="/concepts/architecture">
How it works and how it measures up against alternatives.
</Card>
<Card title="Usage Limits" href="/concepts/limit">
<Card icon={<Gauge />} title="Usage Limits" href="/concepts/limit">
The boundaries you should know before committing.
</Card>
</Cards>

### Deploying and operating?

<Cards>
<Card title="Installation Guide" href="/installation/">
<Card icon={<Server />} title="Installation Guide" href="/installation/">
Linux (single-node to multi-node), Docker, Kubernetes, Windows, macOS.
</Card>
<Card title="Production Checklists" href="/installation/checklists/hardware-checklists">
<Card icon={<ClipboardCheck />} title="Production Checklists" href="/installation/checklists/hardware-checklists">
Hardware, network, software, and security prep.
</Card>
<Card title="Operations" href="/upgrade-scale/upgrade">
<Card icon={<Activity />} title="Operations" href="/upgrade-scale/upgrade">
Rolling upgrades, scaling, troubleshooting, and data healing.
</Card>
</Cards>

### Building an application?

<Cards>
<Card title="SDKs" href="/developer/sdk">
<Card icon={<Code />} title="SDKs" href="/developer/sdk">
Java, Python, Go, Rust, JavaScript/TypeScript — any S3 client works.
</Card>
<Card title="Tool Examples" href="/developer/examples/mc">
<Card icon={<Terminal />} title="Tool Examples" href="/developer/examples/mc">
Minimal recipes for mc, AWS CLI, boto3, and rclone.
</Card>
<Card title="Reference" href="/reference/environment-variables">
<Card icon={<Library />} title="Reference" href="/reference/environment-variables">
Environment variables, CLI, ports, limits, and glossary.
</Card>
</Cards>
Expand Down
26 changes: 26 additions & 0 deletions press.config.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,20 @@ import defaultMdxComponents, { createRelativeLink } from "fumadocs-ui/mdx";
import { docs } from "./.source/server";
import { Mermaid } from "./src/components/mermaid";
import { Tab, Tabs } from "./src/components/tabs";
// Lucide icons registered for use in MDX (e.g. <Card icon={<Rocket />} />).
import {
Rocket,
Container,
BookOpen,
Network,
Gauge,
Server,
ClipboardCheck,
Activity,
Code,
Terminal,
Library,
} from "lucide-react";

const isDev = import.meta.env.DEV;

Expand Down Expand Up @@ -211,6 +225,18 @@ gtag('config', 'G-TWW7WMTWL9');`,
Mermaid,
Tab,
Tabs,
// Lucide icons for <Card icon={<Rocket />} /> on landing pages.
Rocket,
Container,
BookOpen,
Network,
Gauge,
Server,
ClipboardCheck,
Activity,
Code,
Terminal,
Library,
};
},
}),
Expand Down
Loading