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
1.2 KiB
1.2 KiB
| title | linkTitle | menu | ||||
|---|---|---|---|---|---|---|
| Documentation | Documentation |
|
Edge Developer Platform (EDP) Documentation
Welcome to the EDP documentation. This documentation serves developers, engineers, and auditors who want to understand, use, and audit the Edge Developer Platform.
Target Audience
- Developers & Engineers: Learn how to use the platform, deploy applications, and integrate services
- Platform Engineers: Understand the architecture, components, and operational aspects
- Auditors & Governance: Access project history, decisions, and compliance information
Documentation Structure
The documentation follows a top-down approach focusing on outcomes and practical usage:
- Platform Overview: High-level introduction and product structure
- Components: Individual platform components and their usage
- Getting Started: Onboarding and quick start guides
- Operations: Deployment, monitoring, and troubleshooting
- Governance: Project history, decisions, and compliance
Purpose
This documentation describes the outcomes and products of the edgeDeveloperFramework (eDF) project. The EDP is designed as a usable, integrated platform with clear links to repositories and implementation details.