docs(documentation): finished documentation entry points 'Documentation' and 'Edge Developer platform'
This commit is contained in:
parent
a915c372db
commit
840c607d27
9 changed files with 42 additions and 48 deletions
|
|
@ -10,7 +10,7 @@ menu:
|
|||
|
||||
Welcome to the EDP documentation. This documentation serves developers, engineers, and auditors who want to understand, use, and audit the Edge Developer Platform.
|
||||
|
||||
{{< likec4-view view="developer-landscape-with-foundry" project="architecture" title="High level eDF Vision: DevOps enhanced by Platform integration with a deployment channel to Edge Connect" >}}
|
||||
It describes the outcomes and products of the edgeDeveloperFramework (eDF) sub-project within IPCEI-CIS.
|
||||
|
||||
## Target Audience
|
||||
|
||||
|
|
@ -20,14 +20,8 @@ Welcome to the EDP documentation. This documentation serves developers, engineer
|
|||
|
||||
## Documentation Structure
|
||||
|
||||
The documentation follows a top-down approach focusing on outcomes and practical usage:
|
||||
The documentation is organized into three core areas:
|
||||
|
||||
* **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
|
||||
* **Edge Developer Platform (EDP)**: The central platform to support developers working in the Edge, based around Forgejo
|
||||
* **Edge Connect Cloud**: The IPCEI-CIS channel of EDP deployments per secure connectivity solutions for edge devices and environments
|
||||
* **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.
|
||||
|
|
|
|||
|
|
@ -6,29 +6,15 @@ description: >
|
|||
A platform to support developers working in the Edge, based around Forgejo
|
||||
---
|
||||
|
||||
{{% alert title="Draft" color="warning" %}}
|
||||
**Editorial Status**: This page is currently being developed.
|
||||
|
||||
* **Jira Ticket**: TBD
|
||||
* **Assignee**: Team
|
||||
* **Status**: Draft - Initial structure created
|
||||
* **Last Updated**: 2025-11-16
|
||||
* **TODO**:
|
||||
* [ ] Add detailed product structure from excalidraw
|
||||
* [ ] Include platform maturity matrix
|
||||
* [ ] Add links to component pages as they are created
|
||||
{{% /alert %}}
|
||||
|
||||
## Purpose
|
||||
|
||||
The Edge Developer Platform (EDP) is a comprehensive DevOps platform designed to enable developers to build, deploy, and operate cloud-native applications at the edge. It provides an integrated suite of tools and services covering the entire software development lifecycle.
|
||||
|
||||
## Target Audience
|
||||
{{< likec4-view view="application-transition" project="architecture" title="EDP Context View: Edge Developer Platform Components and User Interaction" >}}
|
||||
|
||||
* **Developers**: Build and deploy applications using standardized workflows
|
||||
* **Platform Engineers**: Operate and maintain the platform infrastructure
|
||||
* **DevOps Teams**: Implement CI/CD pipelines and automation
|
||||
* **Auditors**: Verify platform capabilities and compliance
|
||||
The magenta **EDP** represents the developer platform: a shared, productized layer that enables modern DevOps by standardizing how applications are described, built, deployed, and observed. In the **inner loop**, developers iterate locally (fast feedback: code → run → test). EDP then connects that work to an **outer loop** where additional roles (review, test, operations, audit/compliance) contribute feedback and controls for production readiness.
|
||||
|
||||
In this modern DevOps setup, EDP acts as the hub: it synchronizes with local development and **deploys applications to target clouds** (for example, an EdgeConnect cloud), while providing the operational capabilities needed to run them safely. Agentic AI can support both loops—for example by assisting developers with implementation and testing in the inner loop, and by automating reviews, policy checks, release notes, and deployment verification (including drift detection and remediation) in the outer loop.
|
||||
|
||||
## Product Structure
|
||||
|
||||
|
|
@ -46,14 +32,6 @@ Tools and services that developers interact with directly to build, test, and de
|
|||
|
||||
Infrastructure automation, observability, and operational tooling for platform management.
|
||||
|
||||
## Platform Maturity
|
||||
|
||||
Components in EDP have different maturity levels:
|
||||
|
||||
* **Production**: Fully integrated and supported for production use
|
||||
* **Beta**: Available for testing with potential changes
|
||||
* **Experimental**: Early stage, subject to significant changes
|
||||
|
||||
## Getting Started
|
||||
|
||||
For quick start guides and onboarding information, see the [Getting Started](../getting-started/) section.
|
||||
|
|
|
|||
5
resources/edp-likec4/images/person-profile.svg
Normal file
5
resources/edp-likec4/images/person-profile.svg
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 64 64" role="img" aria-label="Person profile">
|
||||
<title>Person profile</title>
|
||||
<path fill="currentColor" d="M28 10c6 0 11 5 11 11 0 5.9-4.2 10.7-9.7 11.7 6.3.6 15.7 4.1 15.7 12.8v4H10v-4c0-6.7 7-10.2 13.9-11.9C18.7 33 15 28 15 22c0-6.1 6.4-12 13-12Zm0 6c-3.5 0-7 3.3-7 6 0 3.8 2.5 7 7 7 3.8 0 5-2.1 5.8-3.5.5-.9 1-1.8 2.2-2.5C35.5 19.2 32.1 16 28 16Z"/>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 455 B |
|
|
@ -1,8 +1,8 @@
|
|||
model {
|
||||
developer = actor 'Developer' {
|
||||
description 'The regular user of the platform'
|
||||
-> localbox 'inner loop development'
|
||||
-> edp 'outer loop development'
|
||||
-> localbox 'inner loop'
|
||||
-> edp 'outer loop'
|
||||
-> edp.ui 'manages project'
|
||||
-> edp.forgejo 'manages code'
|
||||
-> edp.keycloak 'authenticates'
|
||||
|
|
@ -22,7 +22,7 @@ model {
|
|||
}
|
||||
otherProductLifecycleRoles = actor 'Reviewer, Tester, Auditors, Operators' {
|
||||
description 'Coworking roles in the outer loop'
|
||||
-> edp 'act according to responibility'
|
||||
-> edp 'review / operate'
|
||||
}
|
||||
customers = actor 'End Customers' {
|
||||
description 'Consumers of your Application'
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ model {
|
|||
technology 'Kubernetes'
|
||||
icon tech:kubernetes
|
||||
-> enterprise 'integrates'
|
||||
-> cloud 'deploys and observes'
|
||||
-> cloud 'deploy & observe'
|
||||
-> localbox // inner-outer loop synchronization
|
||||
|
||||
application = schema 'application' {
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@ model {
|
|||
localbox = system 'localbox' {
|
||||
description 'A local development system'
|
||||
technology 'Linux/Windows/Mac'
|
||||
-> edp 'inner-outer-loop synchronization'
|
||||
-> edp 'sync'
|
||||
-> enterprise 'company integration'
|
||||
|
||||
application = schema 'application' {
|
||||
|
|
|
|||
|
|
@ -1,4 +1,7 @@
|
|||
specification {
|
||||
// Custom color used for view-local highlighting
|
||||
color magenta #b100ff
|
||||
|
||||
element actor {
|
||||
style {
|
||||
shape person
|
||||
|
|
|
|||
|
|
@ -3,12 +3,15 @@ views {
|
|||
// the application meta-definition travels through all deploying components
|
||||
view application-transition {
|
||||
title 'application-transistion'
|
||||
// autoLayout LeftRight 100 100
|
||||
autoLayout LeftRight 180 140
|
||||
|
||||
// include *
|
||||
exclude developer, localbox, edp, otherProductLifecycleRoles
|
||||
exclude element.kind = workflow
|
||||
include cloud, cloud.application
|
||||
include cloud with {
|
||||
title 'EdgeConnect Cloud'
|
||||
}
|
||||
include cloud.application
|
||||
|
||||
group 'developer-scope' {
|
||||
color green
|
||||
|
|
@ -31,5 +34,16 @@ views {
|
|||
include edp, edp.application
|
||||
}
|
||||
}
|
||||
|
||||
// Only in this view: highlight EDP itself
|
||||
style edp {
|
||||
color magenta
|
||||
}
|
||||
|
||||
// Make actors more "icon-like" (no subtitle/description in-node)
|
||||
style developer, otherProductLifecycleRoles {
|
||||
size xsmall
|
||||
textSize small
|
||||
}
|
||||
}
|
||||
}
|
||||
File diff suppressed because one or more lines are too long
Loading…
Add table
Add a link
Reference in a new issue