doc(technical-documentation): initial port of technical documentation

This commit is contained in:
Stephan Lo 2024-12-19 14:28:28 +01:00
parent 22967405ab
commit 866dca1655
7 changed files with 63 additions and 18 deletions

View file

@ -0,0 +1,7 @@
# Technical Documentation
## Outline
1. Concepts
The underlying platforming concepts of the Edge Developer Framework (EDF) solution, i.e. the problem domain

View file

@ -0,0 +1,32 @@
# 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)
## 🧐 What is it?
## 📦 Main features
## ⏱️ Quick start guide
## ⚙️ Configuration
## 🔗 References
- Technical Documentation

View file

@ -6,3 +6,4 @@ description: 'The center of everything else, the reason, driver and center of al
---
> The center of everything else, the reason, driver and center of all being: Running Code

View file

@ -1,11 +1,11 @@
+++
title = "CNOE"
weight = 4
+++
---
title: CNOE
weight: 4
---
* https://cnoe.io/docs/intro
> The goal for the CNOE framework is to bring together a cohort of enterprises operating at the same scale so that they can navigate their operational technology decisions together, de-risk their tooling bets, coordinate contribution, and offer guidance to large enterprises on which CNCF technologies to use together to achieve the best cloud efficiencies.
### Aussprache

View file

@ -1,7 +1,7 @@
+++
title = "Humanitec"
weight = 4
+++
---
title: Humanitec
weight: 4
---
tbd

View file

@ -6,3 +6,7 @@ description: Platform automation is the next level of platforming
---
* [CNOE](./CNOE/_index.md)
* [Humanitec](./Humanitec/_index.md)
* [Kratix](./Kratix/_index.md)
* [BACKstack]()

View file

@ -3,9 +3,10 @@ site_description: 'EDP documentation'
nav:
- Home: index.md
- Overview:
- User Documentation: gettingstarted/user-documentation.md
- User Guide:
- Introduction:
- User Documentation: introduction/user-documentation.md
- Technical Documentation: introduction/technical-documentation.md
- User Documentation:
- ArgoCD: userguide/argocd.md
- Backstage: userguide/backstage.md
- CI Workflow: userguide/ci-workflow.md
@ -17,15 +18,15 @@ nav:
- OpenBAO: userguide/openbao.md
- PetClinic: userguide/petclinic.md
- Technical Documentation:
- Platfrom concepts: technical-documentation/concepts/_index.md
- Deployment: techdocs/deployment.md
- Development: techdocs/development.md
- Testing: techdocs/testing.md
- Platform concepts:
- 'Code: Software and Workloads': technical-documentation/concepts/1_software-and-workloads/_index.md
- Engineers: technical-documentation/concepts/2_engineering-people/_index.md
- Use Cases: technical-documentation/concepts/3_use-cases/_index.md
- Digital Platforms: technical-documentation/concepts/4_digital-platforms/_index.md
- Platform Orchestrators: technical-documentation/concepts/5_platforms/_index.md
- About:
- License: about/license.md
- Release Notes: about/release-notes.md
- A Test doc: about/mkdocs-test.md
plugins:
- techdocs-core