How pingcap/docs works
Main Components
a. Content Organization Layer:
• Documentation versions (branches)
• Language variants (en, zh)
• Content categories (user guides, reference docs, etc.)
b. Infrastructure Layer:
• Source files (Markdown)
• Media assets
• Configuration files
• Build/deployment scripts
c. Integration Layer:
• GitHub workflows
• Translation systems
• PDF generation capabilities
• Monitoring and validation tools
[User Interface Layer]
• Website Rendering (docs.pingcap.com)
• PDF Generation
• Multi-language Support
[Content Management Layer]
• Version Control (Git Branches)
• Content Organization (TOC)
• Media Assets
[Build & Automation Layer]
• GitHub Actions
• Validation Tools
• Translation Pipeline
[Infrastructure Layer]
• Source Files
• Configuration
• Scripts
Key Elements to Label
• Documentation versions
• File types and formats
• Build processes
• Deployment paths
• Quality control points
• Integration points
Notes for Implementation
• Version numbers for clarity
• Both automated and manual processes
• Documentation status (archived vs. active)
• Integration points with external systems