Provisioning Platform Documentation

Complete documentation for the Provisioning Platform infrastructure automation system built with Nushell, Nickel, and Rust.

📖 Browse Documentation

All documentation is directly readable as markdown files in Git/GitHub—mdBook is optional.

Table of Contents – Complete documentation index (188+ pages)
Browse src/ directory – All markdown files organized by topic

For Users & Operators

Getting Started – Installation, setup, and first deployment
Operations Guide – Deployment, monitoring, orchestrator management
Troubleshooting – Common issues and solutions
Security – Authentication, encryption, secrets management

For Developers & Architects

Architecture Overview – System design and integration patterns
Infrastructure Guide – CLI, configuration system, workspaces
Development Guide – Extensions, providers, taskservs, build system
API Reference – REST API, WebSocket, SDKs, integration examples

For Advanced Users

Deployment Guides – Multi-provider setup, customization, infrastructure examples
Integration Guides – Gitea, OCI, service mesh, secrets integration
Testing – Test environment setup and validation

📚 Documentation Structure

provisioning/docs/
├── README.md                    # This file – navigation hub
├── book.toml                    # mdBook configuration
├── src/                         # Source markdown files (version-controlled)
│   ├── SUMMARY.md              # Complete table of contents
│   ├── getting-started/        # Installation and setup
│   ├── architecture/           # System design and ADRs
│   ├── infrastructure/         # CLI, configuration, workspaces
│   ├── operations/             # Deployment, orchestrator, monitoring
│   ├── development/            # Extensions, providers, build system
│   ├── api-reference/          # APIs and SDKs
│   ├── security/               # Authentication, secrets, encryption
│   ├── integration/            # Third-party integrations
│   ├── guides/                 # How-to guides and examples
│   ├── troubleshooting/        # Common issues
│   └── ...                     # 12 other sections
├── book/                        # Generated HTML output (Git-ignored)
└── examples/                    # Example workspace configurations

Why `src/` subdirectory

This is the standard mdBook convention:

Source (src/): Version-controlled markdown files, directly readable
Output (book/): Generated HTML/CSS/JS, Git-ignored (regenerated on build)

This separation allows the same source files to generate multiple output formats (HTML, PDF, EPUB) without cluttering the version-controlled repository.

🔨 Building HTML with mdBook

If you prefer a formatted HTML website with search, themes, and copy buttons, build with mdBook:

Prerequisites

cargo install mdbook

Build & Serve

# Navigate to docs directory
cd provisioning/docs

# Build HTML to book/ directory
mdbook build

# Serve locally at http://localhost:3000 (with live reload)
mdbook serve

Output

Generated HTML is available in provisioning/docs/book/ after building.

Note: mdBook is entirely optional. The markdown files in src/ work perfectly fine in any Git viewer or text editor.

📖 Reading Markdown Directly

All documentation is standard GitHub Flavored Markdown. You can:

GitHub/GitLab: Click provisioning/docs/src/ and browse directly
Local Git: Clone the repo and open any .md file in your editor
Text Search: Use grep or your editor's search to find topics across all markdown files
mdBook (optional): Build HTML for formatted reading with search and theming

🔗 Key Reference Pages

Document	Purpose
System Overview	High-level architecture
Installation Guide	Step-by-step setup
CLI Reference	Command reference
Configuration System	Config management
Security System	Authentication & encryption
Orchestrator	Service orchestration
Workspace Guide	Infrastructure workspaces
ADRs	Architecture Decision Records

❓ Questions

Getting started → Start with Installation Guide
Having issues → Check Troubleshooting
Looking for API docs → See API Reference
Want architecture details → Read Architecture Overview

For complete navigation, see Table of Contents.

5.8 KiB Raw Blame History Unescape Escape