Documentation Directory¶

This directory contains all documentation for the Qubinode KVM Host Setup Collection. The documentation is organized using the Diátaxis framework for optimal user experience.

📚 Primary Documentation (Diátaxis Framework)¶

🎯 Start Here: Diátaxis Documentation ¶

Our main documentation follows the Diátaxis framework and is organized by user intent:

📚 Tutorials - Learn by doing with step-by-step guides
🛠️ How-To Guides - Solve specific problems
👨‍💻 Developer Guides - Contribute to the project
📖 Reference - Look up technical details
💡 Explanations - Understand architecture and design

📁 Legacy Documentation (Being Migrated)¶

The following documentation is being migrated to the Diátaxis framework:

⚠️ Migration Status¶

✅ Migrated: Content moved to Diátaxis structure
🔄 In Progress: Currently being migrated
📋 Planned: Scheduled for migration

User Documentation¶

✅ USER_INSTALLATION_GUIDE.md → Tutorials and How-To Guides
✅ compatibility_report.md → Platform Support
✅ FEATURE_COMPATIBILITY_MATRIX.md → Feature Matrix

Developer Documentation¶

✅ DEPENDABOT_SETUP_GUIDE.md → Setup Dependabot
✅ MOLECULE_MIGRATION_GUIDE.md → Migrate Molecule Tests
✅ MANDATORY_LOCAL_TESTING.md → Local Testing Requirements
🔄 ANSIBLE_LINT_AUTOMATION.md → Developer How-To Guides
🔄 local-molecule-setup.md → Developer How-To Guides

Reference Documentation¶

✅ role_interface_standards.md → Role Interface Standards
✅ variable_naming_conventions.md → Variable Naming
🔄 ANSIBLE_COLLECTION_SECURITY.md → Reference Documentation
🔄 REDHAT_REGISTRY_SETUP.md → Reference Documentation

Architectural Documentation¶

✅ adrs/ → Architecture Decisions
✅ DEVOPS_AUTOMATION_FRAMEWORK.md → Automation Philosophy
🔄 AUTOMATION_ENABLEMENT_STRATEGY.md → Explanations
🔄 RELEASE_STRATEGY.md → Explanations

🗂️ Directory Structure¶

docs/
├── diataxis/                    # 📚 Main documentation (Diátaxis framework)
│   ├── tutorials/              # 📚 Learning-oriented guides
│   ├── how-to-guides/          # 🛠️ Problem-solving guides
│   │   └── developer/          # 👨‍💻 Developer-specific guides
│   ├── reference/              # 📖 Technical specifications
│   └── explanations/           # 💡 Architecture and concepts
├── adrs/                       # 🔄 Architecture Decision Records (migrating)
├── research/                   # 🔄 Research documentation (migrating)
├── audit-reports/              # 🔄 Audit results (migrating)
├── session-reports/            # 🔄 Implementation reports (migrating)
└── archive/                    # 📦 Historical documentation

🔄 Migration Progress¶

Completed Migrations ✅¶

Core Diátaxis structure created
Essential tutorials and how-to guides
Key developer documentation
Primary reference materials
Core architectural explanations

In Progress 🔄¶

Remaining developer automation guides
Complete reference documentation
All ADRs and architectural decisions
Research and analysis documentation

Planned 📋¶

Legacy documentation cleanup
Link updates throughout codebase
Archive organization
Final validation and testing

🔗 External Links¶

Ansible Resources¶

Project Resources¶

Framework Resources¶

📞 Support and Community¶

Getting Help¶

Documentation: Search our Diátaxis documentation
Issues: Report bugs or request features
Discussions: Community support and questions

Contributing¶

Code: Follow our Contributing Guidelines
Documentation: Help improve our documentation
Testing: Enhance test coverage and scenarios
Feedback: Share your experience and suggestions

This documentation is continuously improved. For the most current information, always refer to the Diátaxis documentation.