doc(contents): update user documentation outline and enhance technical documentation

This commit is contained in:
Stephan Lo 2024-12-20 14:09:36 +01:00
parent df186af47c
commit 304fbdcdcb

View file

@ -9,36 +9,27 @@ Both are outlined in the following.
## User Documentation
### 📋 Outline
- [What is it? (short description what the software does, max 3 sentences)](#what-is-it)
- A couple of use cases (different scopes)
- Why do I need / want this? When should I pass?
- Compare with other platforms
- Compare with well-known tools (what parts of my stack / pipeline does this cover?)
- argo -> vercel
- monitoring -> data dog
- forgejo -> graphite
- [Main features (brief list of main features and enablers - why it is in the stack)](#main-features)
- what are our opinions / core principles and believes that are backed in?
- k8s > *
- Developer Portal: Backstage
- [Quick start guide](#quick-start-guide)
- [Configuration](#configuration)
- structure of the poc (where / how can I change something?)
- how does it work? (bootstrapping++)
- [Known Issues / TODOs](#known-issues)
- [References (documentation links etc...)](#references)
A 'user' is someone who accesses a predeployed EDP and wants to drive developer use cases.
### 🧐 What is it?
10:40 THU
When you enter a EDP as a development user the EDP is an Internal Development Platform.
### 📦 Main features
### ⏱️ Quick start guide
* Start new use cases
* Search, browse, monitor and revoke already run use cases
### ⚙️ Configuration
### ⏱️ Quick start guide (WiP)
### 🔗 References
* 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