fe0365757a
- Added generated index files and report directories to .gitignore to prevent unnecessary tracking of transient files. - Updated README links to reflect new documentation paths for better navigation. - Improved documentation organization by ensuring all links point to the correct locations, enhancing user experience and accessibility.
162 lines
8.0 KiB
Markdown
162 lines
8.0 KiB
Markdown
# Sankofa Phoenix Documentation
|
|
|
|
Complete documentation for the Sankofa Phoenix sovereign cloud platform.
|
|
|
|
## Quick Links
|
|
|
|
- **[Main README](../README.md)** - Project overview and getting started
|
|
- **[Configuration Guide](./CONFIGURATION_GUIDE.md)** - Setup and configuration
|
|
- **[Environment Variables](./ENV_EXAMPLES.md)** - Environment variable examples
|
|
|
|
## Documentation Structure
|
|
|
|
### Guides
|
|
- **[Guides Directory](./guides/)** - Step-by-step guides and how-to documentation
|
|
- [Build and Deploy Instructions](./guides/BUILD_AND_DEPLOY_INSTRUCTIONS.md)
|
|
- [Force Unlock Instructions](./guides/FORCE_UNLOCK_INSTRUCTIONS.md)
|
|
- [Guest Agent Guides](./guides/QUICK_INSTALL_GUEST_AGENT.md)
|
|
|
|
### Reference
|
|
- **[Reference Directory](./reference/)** - Reference materials and specifications
|
|
- [Code Inconsistencies](./reference/CODE_INCONSISTENCIES.md)
|
|
- [Script Documentation](./reference/)
|
|
|
|
### Reports
|
|
- **[Reports Directory](./reports/)** - Audit reports, reviews, and analysis
|
|
- [Audit Reports](./reports/AUDIT_SUMMARY.md)
|
|
- [Review Reports](./reports/PROJECT_COMPREHENSIVE_REVIEW.md)
|
|
- [Documentation Reports](./reports/DOCUMENTATION_DEEP_DIVE_ANALYSIS.md)
|
|
|
|
### Summaries
|
|
- **[Summaries Directory](./summaries/)** - Completion and implementation summaries
|
|
- [Documentation Complete Summary](./summaries/DOCUMENTATION_COMPLETE_SUMMARY.md)
|
|
- [Implementation Summary](./summaries/IMPLEMENTATION_SUMMARY.md)
|
|
|
|
### Deployment
|
|
- **[Deployment Directory](./deployment/)** - Deployment status and planning
|
|
- [Deployment Next Steps](./deployment/DEPLOYMENT_NEXT_STEPS.md)
|
|
- [Deployment Ready](./deployment/DEPLOYMENT_READY.md)
|
|
- [Pre-Deployment Checklist](./deployment/PRE_DEPLOYMENT_CHECKLIST.md)
|
|
|
|
### VM Documentation
|
|
- **[VM Directory](./vm/)** - Virtual Machine documentation
|
|
- [VM Creation Procedure](./vm/VM_CREATION_PROCEDURE.md)
|
|
- [VM Deployment Checklist](./vm/VM_DEPLOYMENT_CHECKLIST.md)
|
|
- [VM Specifications](./vm/VM_SPECIFICATIONS.md)
|
|
|
|
### Guest Agent
|
|
- **[Guest Agent Directory](./guest-agent/)** - Guest agent documentation
|
|
- [Guest Agent Checklist](./guest-agent/GUEST_AGENT_CHECKLIST.md)
|
|
- [Guest Agent Configuration Analysis](./guest-agent/GUEST_AGENT_CONFIGURATION_ANALYSIS.md)
|
|
|
|
### Architecture
|
|
- **[System Architecture](./system_architecture.md)** - Overall system architecture
|
|
- **[Ecosystem Architecture](./ecosystem-architecture.md)** - Ecosystem structure
|
|
- **[Datacenter Architecture](./datacenter_architecture.md)** - Datacenter specifications
|
|
- **[Blockchain Architecture](./blockchain_eea_architecture.md)** - Blockchain integration
|
|
- **[Data Model](./architecture/data-model.md)** - GraphQL schema and data model
|
|
- **[Tech Stack](./architecture/tech-stack.md)** - Technology stack details
|
|
|
|
### Infrastructure
|
|
- **[Infrastructure README](../infrastructure/README.md)** - Infrastructure management overview
|
|
- **[Proxmox Documentation](./proxmox/README.md)** - Complete Proxmox documentation
|
|
- [Quick Start](./proxmox/guides/QUICK_START.md) - Get started with Proxmox
|
|
- [Deployment Guide](./proxmox/guides/DEPLOYMENT_GUIDE.md) - Deployment procedures
|
|
- [Configuration](./proxmox/DNS_CONFIGURATION.md) - Configuration guides
|
|
- **[Domain Migration](./infrastructure/DOMAIN_MIGRATION.md)** - Domain migration documentation
|
|
|
|
### Development
|
|
- **[Development Guide](./DEVELOPMENT.md)** - Development setup and workflow
|
|
- **[Testing Guide](./TESTING.md)** - Testing strategies and examples
|
|
- **[Deployment Guide](./DEPLOYMENT.md)** - Production deployment instructions
|
|
- **[Troubleshooting Guide](./TROUBLESHOOTING_GUIDE.md)** - Comprehensive troubleshooting guide
|
|
|
|
### Deployment & Status
|
|
- **[Deployment Requirements](./DEPLOYMENT_REQUIREMENTS.md)** - Complete deployment requirements
|
|
- **[Deployment Execution Plan](./DEPLOYMENT_EXECUTION_PLAN.md)** - Step-by-step execution guide
|
|
- **[Deployment Index](./DEPLOYMENT_INDEX.md)** - Navigation guide
|
|
- **[Infrastructure Ready](./INFRASTRUCTURE_READY.md)** - Current infrastructure status
|
|
- **[Deployment Guide](./DEPLOYMENT.md)** - Production deployment instructions
|
|
|
|
### Operations
|
|
- **[Runbooks](./runbooks/)** - Operational runbooks
|
|
- VM Provisioning
|
|
- Troubleshooting
|
|
- Disaster Recovery
|
|
|
|
### Brand & Positioning
|
|
- **[Brand Documentation](./brand/)** - Brand philosophy and positioning
|
|
- **[Ecosystem Mapping](./brand/ecosystem-mapping.md)** - Ecosystem structure
|
|
|
|
### Tenants (Multi-Tenancy)
|
|
- **[Tenant Management](./tenants/TENANT_MANAGEMENT.md)** - Comprehensive tenant management guide
|
|
- **[Billing Guide](./tenants/BILLING_GUIDE.md)** - Advanced billing features (superior to Azure)
|
|
- **[Identity Setup](./tenants/IDENTITY_SETUP.md)** - Keycloak and identity provider setup
|
|
- **[Azure Migration Guide](./tenants/AZURE_MIGRATION.md)** - Guide for migrating from Azure
|
|
|
|
## Key Features
|
|
|
|
### Sovereign Infrastructure
|
|
- **NO Azure/Microsoft dependencies** - All solutions are self-hosted
|
|
- **Superior to Azure** - More flexible, granular, and better UX than Azure
|
|
- **Sovereign-owned hardware** - Complete control over infrastructure
|
|
|
|
### Multi-Tenancy
|
|
- **Keycloak-based identity** - Sovereign alternative to Azure AD
|
|
- **Fine-grained permissions** - Beyond Azure RBAC
|
|
- **Custom domains per tenant** - Better than Azure
|
|
- **Cross-tenant resource sharing** - More flexible than Azure
|
|
|
|
### Billing (Superior to Azure Cost Management)
|
|
- **Per-second granularity** - vs Azure's hourly
|
|
- **Real-time cost tracking** - Better than Azure
|
|
- **ML-based forecasting** - Predictive cost analysis
|
|
- **Blockchain-backed billing** - Immutable audit trail
|
|
|
|
### Current Status
|
|
- **[Infrastructure Ready](./INFRASTRUCTURE_READY.md)** - Current infrastructure status
|
|
- **[Deployment Guide](./DEPLOYMENT.md)** - Production deployment instructions
|
|
- **[Status Reports](./status/)** - Current status reports by category
|
|
- [Build Status](./status/builds/) - Build and test results
|
|
- [Deployment Status](./status/deployments/) - Deployment status reports
|
|
- [VM Status](./status/vms/) - VM-related status and analysis
|
|
- [Tasks](./status/tasks/) - Task tracking and remaining work
|
|
- **[Archived Reports](./archive/)** - Historical reports and audits
|
|
|
|
### SMOM-DBIS-138
|
|
- **[SMOM-DBIS-138 Index](./smom-dbis-138-INDEX.md)** - Navigation guide
|
|
- **[SMOM-DBIS-138 Quick Start](./smom-dbis-138-QUICK_START.md)** - Quick start guide
|
|
- **[SMOM-DBIS-138 Next Steps](./smom-dbis-138-next-steps.md)** - Next steps guide
|
|
- **[SMOM-DBIS-138 Project Integration](./smom-dbis-138-project-integration.md)** - Integration guide
|
|
- **[SMOM-DBIS-138 Complete Summary](./archive/status/smom-dbis-138-COMPLETE_SUMMARY.md)** - Complete summary (archived)
|
|
|
|
## Archive
|
|
|
|
Historical documentation is archived in [docs/archive/](./archive/) for reference:
|
|
- [Audit Reports](./archive/audits/) - Historical audit reports
|
|
- [Status Reports](./archive/status/) - Archived status reports
|
|
- [Build Results](./archive/builds/) - Historical build results
|
|
- [Deployment Reports](./archive/deployments/) - Historical deployment reports
|
|
|
|
## Documentation Index
|
|
|
|
- **[Markdown Reference Index](./MARKDOWN_REFERENCE.md)** - Complete index of all Markdown files with headings and line numbers
|
|
- **[Markdown Deduplication Report](./MARKDOWN_DEDUPLICATION_REPORT.md)** - Analysis of documentation organization and deduplication
|
|
- **[Markdown Reference JSON](./MARKDOWN_REFERENCE.json)** - Machine-readable index (JSON format)
|
|
- **[Documentation Organization](./ORGANIZATION.md)** - Guide to documentation structure and organization
|
|
|
|
## Documentation Indexes
|
|
|
|
Quick navigation to specific documentation types:
|
|
- **[Guides Index](./GUIDES_INDEX.md)** - All how-to guides and tutorials
|
|
- **[Reference Index](./REFERENCE_INDEX.md)** - API docs, specs, and reference material
|
|
- **[Architecture Index](./ARCHITECTURE_INDEX.md)** - Architecture and design documentation
|
|
|
|
## Documentation Maintenance
|
|
|
|
For documentation improvements and audits, see:
|
|
- **[Documentation Deep-Dive Analysis](reports/DOCUMENTATION_DEEP_DIVE_ANALYSIS.md)** - Comprehensive documentation analysis
|
|
- **[Documentation Fixes Applied](reports/DOCUMENTATION_FIXES_APPLIED.md)** - Recent documentation improvements
|
|
- **[Audit Summary](reports/AUDIT_SUMMARY.md)** - Quick audit reference
|
|
|