45 lines
1.7 KiB
Markdown
45 lines
1.7 KiB
Markdown
---
|
|
title: "Documentation"
|
|
linkTitle: "Documentation"
|
|
menu:
|
|
main:
|
|
weight: 20
|
|
---
|
|
|
|
{{% alert title="Draft" color="warning" %}}
|
|
**Editorial Status**: This page is currently being developed.
|
|
|
|
* **Jira Ticket**: [TICKET-XXX](https://your-jira/browse/TICKET-XXX)
|
|
* **Assignee**: [Name or Team]
|
|
* **Status**: Draft
|
|
* **Last Updated**: YYYY-MM-DD
|
|
* **TODO**:
|
|
* [ ] Add detailed component description
|
|
* [ ] Include usage examples and code samples
|
|
* [ ] Add architecture diagrams
|
|
* [ ] Review and finalize content
|
|
{{% /alert %}}
|
|
|
|
# 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.
|