c39465c2bd
Some checks failed
Test / test (push) Has been cancelled
Co-authored-by: Cursor <cursoragent@cursor.com>
92 lines
3.8 KiB
Markdown
92 lines
3.8 KiB
Markdown
# Documentation Index
|
|
|
|
This is the master index for all project documentation. Documentation is organized by purpose to make it easy to find what you need.
|
|
|
|
## Getting Started
|
|
|
|
- [Quick Start Guide](getting-started/quick-start.md) - Get up and running quickly
|
|
- [Prerequisites](getting-started/prerequisites.md) - System requirements and prerequisites
|
|
- [Installation Guide](getting-started/installation.md) - Step-by-step installation instructions
|
|
|
|
## Architecture
|
|
|
|
- [Architecture Overview](architecture/overview.md) - High-level system architecture
|
|
- [Complete Architecture](architecture/complete-architecture.md) - Detailed architecture documentation
|
|
- [Network Topology](architecture/network-topology.md) - Network design and VLAN configuration
|
|
- [Hardware BOM](architecture/hardware-bom.md) - Bill of materials and hardware specifications
|
|
- [PCIe Allocation](architecture/pcie-allocation.md) - PCIe slot allocation map
|
|
- [Driver Matrix](architecture/driver-matrix.md) - Driver compatibility matrix
|
|
|
|
## Deployment
|
|
|
|
- [Deployment Guide](deployment/deployment-guide.md) - Complete deployment instructions
|
|
- [Bring-Up Checklist](deployment/bring-up-checklist.md) - Day-one installation checklist
|
|
- [Azure Arc Onboarding](deployment/azure-arc-onboarding.md) - Azure Arc integration guide
|
|
- [Cloudflare Integration](deployment/cloudflare-integration.md) - Cloudflare Tunnel and Zero Trust setup
|
|
|
|
## Operations
|
|
|
|
- [Runbooks](operations/runbooks/) - Operational procedures
|
|
- [Proxmox Operations](operations/runbooks/proxmox-operations.md)
|
|
- [Azure Arc Troubleshooting](operations/runbooks/azure-arc-troubleshooting.md)
|
|
- [GitOps Workflow](operations/runbooks/gitops-workflow.md)
|
|
- [Proxmox Ubuntu Images](operations/proxmox-ubuntu-images.md) - Ubuntu image management
|
|
- [Guest Agent Setup](operations/guest-agent-setup.md) - QEMU guest agent configuration
|
|
|
|
## Troubleshooting
|
|
|
|
- [Common Issues](troubleshooting/common-issues.md) - Frequently encountered problems and solutions
|
|
- [VM Troubleshooting](troubleshooting/vm-troubleshooting.md) - VM-specific troubleshooting guide
|
|
|
|
## Security
|
|
|
|
- [Security Guide](security/security-guide.md) - Security best practices and configuration
|
|
- [Proxmox RBAC](security/proxmox-rbac.md) - Role-based access control for Proxmox
|
|
|
|
## Reference
|
|
|
|
- [API Reference](reference/api-reference.md) - API documentation
|
|
- [Command Reference](reference/command-reference.md) - Command-line reference
|
|
|
|
## Archived Documentation
|
|
|
|
- [Temporary Files](temporary/) - Archived temporary files and status reports
|
|
|
|
## Documentation by Topic
|
|
|
|
### For New Users
|
|
1. Start with [Quick Start Guide](getting-started/quick-start.md)
|
|
2. Review [Prerequisites](getting-started/prerequisites.md)
|
|
3. Follow [Installation Guide](getting-started/installation.md)
|
|
|
|
### For Deployment
|
|
1. Review [Architecture Overview](architecture/overview.md)
|
|
2. Follow [Deployment Guide](deployment/deployment-guide.md)
|
|
3. Use [Bring-Up Checklist](deployment/bring-up-checklist.md)
|
|
|
|
### For Operations
|
|
1. Review [Runbooks](operations/runbooks/)
|
|
2. Check [Common Issues](troubleshooting/common-issues.md) for problems
|
|
3. Refer to [Command Reference](reference/command-reference.md) for commands
|
|
|
|
### For Troubleshooting
|
|
1. Check [Common Issues](troubleshooting/common-issues.md)
|
|
2. Review relevant [Runbooks](operations/runbooks/)
|
|
3. Consult [VM Troubleshooting](troubleshooting/vm-troubleshooting.md)
|
|
|
|
## Contributing to Documentation
|
|
|
|
When adding or updating documentation:
|
|
|
|
1. Place files in the appropriate directory
|
|
2. Update this index
|
|
3. Ensure cross-references are correct
|
|
4. Follow the documentation style guide (to be created)
|
|
|
|
## Documentation Maintenance
|
|
|
|
- Documentation index is auto-generated by `scripts/docs/generate-docs-index.sh`
|
|
- Broken links are validated by `scripts/docs/validate-docs.sh`
|
|
- Diagrams are updated by `scripts/docs/update-diagrams.sh`
|
|
|