Stephan Lo
62999b41d0
- Archive old docs to docs-old/ for reference - Create new top-down documentation structure: * Platform Overview: purpose, audience, product structure * Components: individual platform components (Forgejo, Kubernetes, Backstage) * Getting Started: onboarding and quick start guides * Operations: deployment, monitoring, troubleshooting * Governance: ADRs, project history, compliance - Add DOCUMENTATION-GUIDE.md with writing guidelines and templates - Add component template (TEMPLATE.md) for consistent documentation - Simplify root README and move technical docs to doc/ folder - Update test configuration: * Exclude legacy content from markdown linting * Relax HTML validation for theme-generated content * Skip link checking for legacy content in test:links * Keep 'task test' clean for technical writers (100% pass) * Add 'task test:full' with comprehensive link checking - Update home page with corrected markdown syntax - Fix internal links in archived content BREAKING CHANGE: Documentation structure changed from flat to hierarchical top-down approach
2.2 KiB
| title | linkTitle | weight | description |
|---|---|---|---|
| Components | Components | 2 | Overview of EDP platform components and their integration. |
Component Overview
The Edge Developer Platform consists of multiple integrated components. Each component serves specific purposes in the overall platform architecture.
This section provides detailed documentation for each component, including:
- Description and purpose
- Key features and capabilities
- Repository links and resources
- Usage instructions and examples
- Integration points with other components
Core Components
Source Code Management
Forgejo: Self-hosted Git service with repository management, issue tracking, and collaboration features.
GitLab: Enterprise-grade Git repository management with CI/CD integration.
Container Orchestration
Kubernetes: Container orchestration platform for deploying and managing containerized applications.
CI/CD & Automation
Woodpecker: Lightweight CI/CD server with pipeline automation.
GARM: GitHub Actions-compatible runner manager for self-hosted environments.
ArgoCD: GitOps continuous delivery tool for Kubernetes.
Developer Portal
Backstage: Developer portal providing unified interface for platform services, documentation, and tooling.
Observability
VictoriaMetrics: Time-series database for metrics storage and querying.
Prometheus: Metrics collection and alerting.
Grafana: Visualization and dashboards for metrics and logs.
Infrastructure as Code
Terraform: Infrastructure provisioning and management.
Crossplane: Kubernetes-native infrastructure management.
Component Status
Each component page includes current status and maturity level. Check individual component documentation for detailed information.
Template for Component Documentation
When documenting a component, include:
- Overview: Brief description and purpose
- Key Features: Main capabilities and use cases
- Architecture: How it fits into EDP
- Getting Started: Quick start guide
- Usage Examples: Common scenarios and patterns
- Repository: Link to source code and additional resources
- Integration: Connection points with other components
- Status: Current maturity level