forked from DevFW-CICD/edp-doc
doc(technical-documentation): initial port of technical documentation
This commit is contained in:
parent
22967405ab
commit
866dca1655
7 changed files with 63 additions and 18 deletions
7
docs/introduction/technical-documentation.md
Normal file
7
docs/introduction/technical-documentation.md
Normal 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
|
||||||
|
|
32
docs/introduction/user-documentation.md
Normal file
32
docs/introduction/user-documentation.md
Normal 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
|
|
@ -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
|
|
@ -1,7 +1,7 @@
|
||||||
+++
|
---
|
||||||
title = "CNOE"
|
title: CNOE
|
||||||
weight = 4
|
weight: 4
|
||||||
+++
|
---
|
||||||
|
|
||||||
|
|
||||||
* https://cnoe.io/docs/intro
|
* https://cnoe.io/docs/intro
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
+++
|
---
|
||||||
title = "Humanitec"
|
title: Humanitec
|
||||||
weight = 4
|
weight: 4
|
||||||
+++
|
---
|
||||||
|
|
||||||
|
|
||||||
tbd
|
tbd
|
|
@ -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]()
|
19
mkdocs.yaml
19
mkdocs.yaml
|
@ -3,9 +3,10 @@ site_description: 'EDP documentation'
|
||||||
|
|
||||||
nav:
|
nav:
|
||||||
- Home: index.md
|
- Home: index.md
|
||||||
- Overview:
|
- Introduction:
|
||||||
- User Documentation: gettingstarted/user-documentation.md
|
- User Documentation: introduction/user-documentation.md
|
||||||
- User Guide:
|
- Technical Documentation: introduction/technical-documentation.md
|
||||||
|
- User Documentation:
|
||||||
- ArgoCD: userguide/argocd.md
|
- ArgoCD: userguide/argocd.md
|
||||||
- Backstage: userguide/backstage.md
|
- Backstage: userguide/backstage.md
|
||||||
- CI Workflow: userguide/ci-workflow.md
|
- CI Workflow: userguide/ci-workflow.md
|
||||||
|
@ -17,15 +18,15 @@ nav:
|
||||||
- OpenBAO: userguide/openbao.md
|
- OpenBAO: userguide/openbao.md
|
||||||
- PetClinic: userguide/petclinic.md
|
- PetClinic: userguide/petclinic.md
|
||||||
- Technical Documentation:
|
- Technical Documentation:
|
||||||
- Platfrom concepts: technical-documentation/concepts/_index.md
|
- Platform concepts:
|
||||||
- Deployment: techdocs/deployment.md
|
- 'Code: Software and Workloads': technical-documentation/concepts/1_software-and-workloads/_index.md
|
||||||
- Development: techdocs/development.md
|
- Engineers: technical-documentation/concepts/2_engineering-people/_index.md
|
||||||
- Testing: techdocs/testing.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:
|
- About:
|
||||||
- License: about/license.md
|
- License: about/license.md
|
||||||
- Release Notes: about/release-notes.md
|
- Release Notes: about/release-notes.md
|
||||||
- A Test doc: about/mkdocs-test.md
|
|
||||||
|
|
||||||
|
|
||||||
plugins:
|
plugins:
|
||||||
- techdocs-core
|
- techdocs-core
|
||||||
|
|
Loading…
Reference in a new issue