feat(docs): restructure documentation with new framework and templates

- 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
This commit is contained in:
Stephan Lo 2025-11-16 13:32:10 +01:00
parent 2ec2efe9fc
commit 62999b41d0
196 changed files with 907 additions and 160 deletions

View file

@ -0,0 +1,102 @@
---
title: "[Component Name]"
linkTitle: "[Short Name]"
weight: 99
description: >
[Brief one-line description of the component]
---
## Overview
[Detailed description of the component - what it is, what it does, and why it exists]
## Key Features
* [Feature 1]
* [Feature 2]
* [Feature 3]
## Purpose in EDP
[Explain the role this component plays in the Edge Developer Platform and how it contributes to the overall platform capabilities]
## Architecture
[Optional: Brief architecture overview or link to detailed architecture documentation]
## Repository
**Code**: [Link to source code repository]
**Documentation**: [Link to component-specific documentation]
## Getting Started
### Prerequisites
* [Prerequisite 1]
* [Prerequisite 2]
### Quick Start
[Step-by-step guide to get started with this component]
1. [Step 1]
2. [Step 2]
3. [Step 3]
### Verification
[How to verify the component is working correctly]
## Usage Examples
### [Use Case 1]
[Example with code/commands showing common use case]
```bash
# Example commands
```
### [Use Case 2]
[Another common scenario]
## Integration Points
* **[Component A]**: [How it integrates]
* **[Component B]**: [How it integrates]
* **[Component C]**: [How it integrates]
## Configuration
[Key configuration options and how to set them]
## Troubleshooting
### [Common Issue 1]
**Problem**: [Description]
**Solution**: [How to fix]
### [Common Issue 2]
**Problem**: [Description]
**Solution**: [How to fix]
## Status
**Maturity**: [Production / Beta / Experimental]
## Additional Resources
* [Link to external documentation]
* [Link to community resources]
* [Link to related components]
## Documentation Notes
[Instructions for team members filling in this documentation - remove this section once complete]

View file

@ -0,0 +1,74 @@
---
title: "Components"
linkTitle: "Components"
weight: 2
description: >
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:
1. **Overview**: Brief description and purpose
2. **Key Features**: Main capabilities and use cases
3. **Architecture**: How it fits into EDP
4. **Getting Started**: Quick start guide
5. **Usage Examples**: Common scenarios and patterns
6. **Repository**: Link to source code and additional resources
7. **Integration**: Connection points with other components
8. **Status**: Current maturity level

View file

@ -0,0 +1,49 @@
---
title: "Backstage"
linkTitle: "Backstage"
weight: 3
description: >
Developer portal providing unified access to platform services and documentation.
---
## Overview
Backstage provides a central developer portal for the EDP, offering unified access to services, documentation, and platform capabilities.
## Key Features
* Service catalog and component registry
* Software templates for rapid application creation
* Documentation hub
* Kubernetes visualization
* API documentation
* Plugin ecosystem for extensibility
## Purpose in EDP
Backstage serves as the entry point for developers, providing discoverability of platform capabilities and streamlined workflows.
## Getting Started
[To be documented: How to access and use Backstage portal]
## Integration Points
* **Forgejo/GitLab**: Repository and CI/CD integration
* **Kubernetes**: Resource visualization and management
* **ArgoCD**: Deployment status and controls
* **Documentation**: Centralized doc access
## Status
**Maturity**: Beta
## Documentation Notes
This is a template page. Team members should fill in:
* Access URL and authentication
* Available plugins and features
* Creating new components from templates
* Service catalog usage
* Customization options

View file

@ -0,0 +1,54 @@
---
title: "Forgejo"
linkTitle: "Forgejo"
weight: 1
description: >
Self-hosted Git service with repository management and collaboration features.
---
## Overview
Forgejo is a self-hosted Git service that provides repository management, issue tracking, pull requests, and collaboration features. It serves as a core component of the EDP for source code management.
## Key Features
* Git repository hosting
* Issue tracking and project management
* Pull requests and code review
* CI/CD integration with Woodpecker
* User and organization management
* API for automation and integration
## Purpose in EDP
Forgejo serves as the primary source code management platform, providing developers with a familiar Git workflow while maintaining full control over the hosting infrastructure.
## Repository
**Code**: [Link to Forgejo repository]
**Documentation**: [Link to Forgejo-specific documentation]
## Getting Started
[To be documented: Quick start guide for using Forgejo in EDP]
## Integration Points
* **Woodpecker CI**: Automated pipeline triggers on git events
* **ArgoCD**: GitOps repository source
* **Backstage**: Service catalog integration
## Status
**Maturity**: Production
## Documentation Notes
This is a template page. Team members should fill in:
* Specific deployment details
* Access URLs and credentials management
* Common workflows and usage patterns
* Troubleshooting information
* Screenshots or examples

View file

@ -0,0 +1,48 @@
---
title: "Kubernetes"
linkTitle: "Kubernetes"
weight: 2
description: >
Container orchestration platform for deploying and managing applications.
---
## Overview
Kubernetes provides the foundation for container orchestration in the EDP, enabling deployment, scaling, and management of containerized applications.
## Key Features
* Container orchestration and scheduling
* Service discovery and load balancing
* Storage orchestration
* Self-healing and automated rollouts
* Configuration and secret management
## Purpose in EDP
Kubernetes serves as the runtime platform for all EDP components and user applications, providing standardized deployment and operations.
## Getting Started
[To be documented: Quick start for deploying to Kubernetes in EDP]
## Integration Points
* **ArgoCD**: Kubernetes deployment automation
* **Crossplane**: Infrastructure provisioning on Kubernetes
* **VictoriaMetrics/Prometheus**: Kubernetes metrics collection
* **Backstage**: Kubernetes resource visualization
## Status
**Maturity**: Production
## Documentation Notes
This is a template page. Team members should fill in:
* Cluster access procedures
* Namespace organization
* Resource quotas and limits
* Network policies
* Storage classes and PV management