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
102 lines
1.8 KiB
Markdown
102 lines
1.8 KiB
Markdown
---
|
|
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]
|