Skip to content

Conversation

brunseba
Copy link
Collaborator

@brunseba brunseba commented Jun 23, 2025


✨ixxeL Home-Lab✨

PR guidelines

sebastien brun added 7 commits June 21, 2025 09:19
- Add comprehensive NEW_CLUSTER_PROVISIONING.md documentation
- Implement FastAPI-based cluster provisioning service
- Add Python models for cluster configuration and API responses
- Create ClusterOrchestrator for workflow coordination
- Add ProxmoxService for VM management
- Include Taskfile integration with cluster provisioning tasks
- Add API example scripts and usage documentation
- Support for automated Talos cluster bootstrap and GitOps generation
- Integration with existing Vault and ArgoCD infrastructure

This provides a complete API-driven solution for provisioning new
Kubernetes clusters following the established genmachine pattern.
- Move ARGOCD_APPLICATION_DEPLOYMENT_GUIDE.md to docs/
- Move FULL_DOCUMENTATION.md to docs/
- Move NEW_CLUSTER_PROVISIONING.md to docs/
- Update mkdocs.yml navigation to reference moved files
- Better organize documentation structure
- Configure pymdownx.superfences with mermaid custom fence
- Add Mermaid.js library via CDN (v10.0.0)
- Create custom mermaid.js initialization script with theme support
- Add responsive Mermaid CSS styling in extra.css
- Support for automatic theme switching (light/dark mode)
- Add comprehensive mermaid-test.md with diagram examples
- Update mkdocs.yml navigation to include test page

Supports flowcharts, sequence diagrams, state diagrams, gitgraph,
and other Mermaid diagram types embedded in markdown files.
- Configure git-revision-date-localized-plugin for last update timestamps
- Add git-committers-plugin for contributor information per page
- Add git-authors-plugin for detailed authorship tracking
- Create generate_git_summary.py script for repository overview
- Add automated git-summary.md page with branch and commit analysis
- Include comprehensive repository statistics and contributor metrics
- Add Taskfile tasks for documentation management (docs:serve, docs:build)
- Enhanced CSS styling for git information display
- Create docs-requirements.txt for MkDocs git plugins
- Add Repository section to navigation with Git Summary page

Features:
- ⏰ Last updated timestamps on each page
- 👥 Author and contributor information
- 📊 Repository statistics and metrics
- 🌿 Branch activity overview with Mermaid diagrams
- 📈 Commit history and contribution analytics
- 🔄 Automated regeneration with task docs:generate-git-summary
- Remove temporary mermaid-test.md file used for testing
- Update mkdocs.yml navigation to remove mermaid test page reference
- Clean up documentation structure

Mermaid functionality is now properly integrated and the test file
is no longer needed. The NEW_CLUSTER_PROVISIONING.md and git-summary.md
files demonstrate working Mermaid diagrams.
- Configure mkdocs-with-pdf plugin with professional layout settings
- Add cover page with logo, title, and subtitle configuration
- Implement hierarchical table of contents with 3-level depth
- Configure chapter numbering for organized document structure
- Exclude git-summary.md from PDF to focus on core documentation
- Create generate_pdf_docs.py script for PDF generation automation
- Add comprehensive PDF generation Taskfile tasks (check, generate, preview, clean)
- Include mkdocs-with-pdf in docs-requirements.txt
- Update .gitignore to exclude PDF output directories
- Create detailed PDF_GENERATION.md documentation guide
- Add PDF Generation page to Repository section in navigation

Features:
📄 Professional PDF layout with cover page and TOC
🎨 Configurable branding with logo and custom titles
📚 Hierarchical table of contents with chapter numbering
🔧 Automated generation with dependency checking
🖥️ Cross-platform PDF preview functionality
📖 Comprehensive documentation and troubleshooting guide
🛠️ Task-based workflow integration
🚀 Environment-based enabling for CI/CD integration

Usage:
- task docs:pdf-check      # Check dependencies
- task docs:pdf-generate   # Generate PDF
- task docs:pdf-preview    # Open PDF for review
- task docs:pdf-clean      # Clean build artifacts
@ixxeL2097 ixxeL2097 force-pushed the main branch 2 times, most recently from 10e41e6 to 352923b Compare June 23, 2025 09:51
@ixxeL2097 ixxeL2097 force-pushed the main branch 9 times, most recently from 4225955 to dfaf826 Compare July 14, 2025 11:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants