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
57 lines
1.5 KiB
Markdown
57 lines
1.5 KiB
Markdown
---
|
|
title: "Getting Started"
|
|
linkTitle: "Getting Started"
|
|
weight: 3
|
|
description: >
|
|
Quick start guides and onboarding information for the Edge Developer Platform.
|
|
---
|
|
|
|
## Welcome to EDP
|
|
|
|
This section helps you get started with the Edge Developer Platform, whether you're a developer building applications or a platform engineer managing infrastructure.
|
|
|
|
## Quick Start for Developers
|
|
|
|
### Prerequisites
|
|
|
|
* Access to EDP instance
|
|
* Git client installed
|
|
* kubectl configured (for Kubernetes access)
|
|
* Basic knowledge of containers and CI/CD
|
|
|
|
### Your First Application
|
|
|
|
1. **Access the Platform**: Log in to Backstage portal
|
|
2. **Clone Repository**: Get your application repository from Forgejo/GitLab
|
|
3. **Configure Pipeline**: Set up CI/CD in Woodpecker or ArgoCD
|
|
4. **Deploy**: Push code and watch automated deployment
|
|
|
|
### Next Steps
|
|
|
|
* Explore available components and services
|
|
* Review platform documentation and best practices
|
|
* Join the developer community
|
|
|
|
## Quick Start for Platform Engineers
|
|
|
|
### Platform Access
|
|
|
|
* Kubernetes cluster access
|
|
* Infrastructure management tools
|
|
* Monitoring and observability dashboards
|
|
|
|
### Key Resources
|
|
|
|
* Platform architecture documentation
|
|
* Operational runbooks
|
|
* Troubleshooting guides
|
|
|
|
## Documentation Template
|
|
|
|
When creating "Getting Started" content for a component:
|
|
|
|
1. **Prerequisites**: What users need before starting
|
|
2. **Step-by-Step Guide**: Clear, numbered instructions
|
|
3. **Verification**: How to confirm success
|
|
4. **Common Issues**: FAQ and troubleshooting
|
|
5. **Next Steps**: Links to deeper documentation
|