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.5 KiB
| title | linkTitle | weight | description |
|---|---|---|---|
| Operations | Operations | 4 | Operational guides for deploying, monitoring, and maintaining the Edge Developer Platform. |
Operations Overview
This section covers operational aspects of the Edge Developer Platform including deployment, monitoring, troubleshooting, and maintenance.
Deployment
Platform Deployment
Instructions for deploying EDP components to your infrastructure.
Application Deployment
Guides for deploying applications to the platform using available deployment methods.
Monitoring & Observability
Metrics
Access and interpret platform and application metrics using VictoriaMetrics, Prometheus, and Grafana.
Logging
Log aggregation and analysis for troubleshooting and audit purposes.
Alerting
Configure alerts for critical platform events and application issues.
Troubleshooting
Common issues and their solutions for platform operations.
Maintenance
Updates & Upgrades
Procedures for updating platform components and maintaining system health.
Backup & Recovery
Data backup strategies and disaster recovery procedures.
Documentation Template
When creating operational documentation:
- Purpose: What this operation achieves
- Prerequisites: Required access, tools, and knowledge
- Procedure: Step-by-step instructions with commands
- Verification: How to confirm successful completion
- Rollback: How to revert if needed
- Troubleshooting: Common issues and solutions