edp-doc/docs/contents.md

# EDP Documentation

The documentation consists of two parts

* User Documentation
* Technical Documentation

Both are outlined in the following.

## User Documentation

A 'user' is someone who accesses a predeployed EDP and wants to drive developer use cases. 

### 🧐 What is it?

When you enter a EDP as a development user the EDP is an Internal Development Platform.

### 📦 Main features

* Start new use cases
* Search, browse, monitor and revoke already run use cases

### ⏱️ Quick start guide (WiP)

* Open the platform URL
* Follow one of the use cases

## Technical Documentation  

EDP is a product developed by the IPCEI-CIS subproject 'edge Developer Framework'. The goal is to provide a cutting edge developer experience for developing and delivering applications in the cloud edge continuum.

It consists of 

* [edpbuilder](https://forgejo.edf-bootstrap.cx.fg1.ffm.osc.live/DevFW/edpbuilder) as a tool to quickly instantiate and manage Internal Development Platforms (IDPs).
* declarative 'platform stack' descriptions which are processed by the orchestrator
doc(README): update documentation structure and add getting started section 2024-12-20 12:51:25 +00:00			`# EDP Documentation`

			`The documentation consists of two parts`

			`* User Documentation`
			`* Technical Documentation`

			`Both are outlined in the following.`

			`## User Documentation`

doc(contents): update user documentation outline and enhance technical documentation 2024-12-20 13:09:36 +00:00			`A 'user' is someone who accesses a predeployed EDP and wants to drive developer use cases.`
doc(README): update documentation structure and add getting started section 2024-12-20 12:51:25 +00:00
			`### 🧐 What is it?`

doc(contents): update user documentation outline and enhance technical documentation 2024-12-20 13:09:36 +00:00			`When you enter a EDP as a development user the EDP is an Internal Development Platform.`
doc(README): update documentation structure and add getting started section 2024-12-20 12:51:25 +00:00
			`### 📦 Main features`

doc(contents): update user documentation outline and enhance technical documentation 2024-12-20 13:09:36 +00:00			`* Start new use cases`
			`* Search, browse, monitor and revoke already run use cases`
doc(README): update documentation structure and add getting started section 2024-12-20 12:51:25 +00:00
doc(contents): update user documentation outline and enhance technical documentation 2024-12-20 13:09:36 +00:00			`### ⏱️ Quick start guide (WiP)`
doc(README): update documentation structure and add getting started section 2024-12-20 12:51:25 +00:00
doc(contents): update user documentation outline and enhance technical documentation 2024-12-20 13:09:36 +00:00			`* Open the platform URL`
			`* Follow one of the use cases`
doc(README): update documentation structure and add getting started section 2024-12-20 12:51:25 +00:00
			`## Technical Documentation`
doc(contents): update user documentation outline and enhance technical documentation 2024-12-20 13:09:36 +00:00
			`EDP is a product developed by the IPCEI-CIS subproject 'edge Developer Framework'. The goal is to provide a cutting edge developer experience for developing and delivering applications in the cloud edge continuum.`

			`It consists of`

			`* [edpbuilder](https://forgejo.edf-bootstrap.cx.fg1.ffm.osc.live/DevFW/edpbuilder) as a tool to quickly instantiate and manage Internal Development Platforms (IDPs).`
			`* declarative 'platform stack' descriptions which are processed by the orchestrator`