- 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
1.7 KiB
| title | linkTitle | weight | description |
|---|---|---|---|
| Platform Overview | Platform Overview | 1 | High-level overview of the Edge Developer Platform (EDP), its purpose, and product structure. |
Purpose
The Edge Developer Platform (EDP) is a comprehensive DevOps platform designed to enable developers to build, deploy, and operate cloud-native applications at the edge. It provides an integrated suite of tools and services covering the entire software development lifecycle.
Target Audience
- Developers: Build and deploy applications using standardized workflows
- Platform Engineers: Operate and maintain the platform infrastructure
- DevOps Teams: Implement CI/CD pipelines and automation
- Auditors: Verify platform capabilities and compliance
Product Structure
EDP consists of multiple integrated components organized in layers:
Core Platform Services
The foundation layer provides essential platform capabilities including source code management, CI/CD, and container orchestration.
Developer Experience
Tools and services that developers interact with directly to build, test, and deploy applications.
Infrastructure & Operations
Infrastructure automation, observability, and operational tooling for platform management.
Platform Maturity
Components in EDP have different maturity levels:
- Production: Fully integrated and supported for production use
- Beta: Available for testing with potential changes
- Experimental: Early stage, subject to significant changes
Getting Started
For quick start guides and onboarding information, see the Getting Started section.
For detailed component information, explore the Components section.