refactor(technical-documentation): first itration finished. can be pushed as mkdocs-awesome-pages-plugin is now implemented in backstage-edp

This commit is contained in:
Stephan Lo 2025-04-09 23:25:31 +02:00
parent 75a2ad1cfa
commit c8695eb403
18 changed files with 49 additions and 41 deletions

View file

@ -0,0 +1,6 @@
title: Technical doc
arrange:
- concepts
- architecture
- product
- project

View file

Before

Width:  |  Height:  |  Size: 66 KiB

After

Width:  |  Height:  |  Size: 66 KiB

View file

@ -1,5 +1,6 @@
title: Concepts title: Concepts
arrange: arrange:
- overview.md
- general - general
- customer-developer - customer-developer
- edp-developer - edp-developer

View file

@ -5,3 +5,6 @@ arrange:
- edge-developer-framework.md - edge-developer-framework.md
- platforming.md - platforming.md
- orchestrators.md - orchestrators.md
- cnoe.md
- cnoe-showtime.md
- conclusio.md

View file

@ -1,18 +0,0 @@
// how to create/export c4 images:
// see also https://likec4.dev/tooling/cli/
docker run -it --rm --name likec4 --user node -v $PWD:/app node bash
npm install likec4
exit
docker commit likec4 likec4
docker run -it --rm --user node -v $PWD:/app -p 5173:5173 likec4 bash
// as root
npx playwright install-deps
npx playwright install
npm install likec4
// render
node@e20899c8046f:/app/content/en/docs/project/onboarding$ ./node_modules/.bin/likec4 export png -o ./images .

View file

@ -6,7 +6,8 @@ description: Next level platforming is orchestrating platforms
## Summary ## Summary
When defining and setting up platforms next two intrinsic problems arise: When defining and setting up platforms next two intrinsic problems arise:
1. it is not declarative and automated 1. it is not declarative and automated
2. it is not or least not easily changable 2. it is not or least not easily changable
@ -21,7 +22,7 @@ This is something extremely new since late 2023 - the rise of the automation of
It was Humanitec creating a definition of platform architecture, as they needed to defien what they are building with their 'orchestrator': It was Humanitec creating a definition of platform architecture, as they needed to defien what they are building with their 'orchestrator':
<img src="./4_orchestrators/vendor-neutral-idp-final.gif" width="600" alt="https://developer.humanitec.com/introduction/overview/"> ![https://developer.humanitec.com/introduction/overview/](./4_orchestrators/vendor-neutral-idp-final.gif)
## Declarative Platform Orchestration ## Declarative Platform Orchestration
@ -29,16 +30,13 @@ Based on the refence architecture you next can build - or let's say 'orchestrate
https://humanitec.com/reference-architectures https://humanitec.com/reference-architectures
<img src="./platform-architectures.webp" width="600" alt="https://humanitec.com/blog/aws-azure-and-gcp-open-source-reference-architectures-to-start-your-mvp">
![https://humanitec.com/blog/aws-azure-and-gcp-open-source-reference-architectures-to-start-your-mvp](./4_orchestrators/platform-architectures.webp)
> Hint: There is a [slides tool provided by McKinsey](https://platformengineering.org/blog/create-your-own-platform-engineering-reference-architectures) to set up your own platform deign based on the reference architecture > Hint: There is a [slides tool provided by McKinsey](https://platformengineering.org/blog/create-your-own-platform-engineering-reference-architectures) to set up your own platform deign based on the reference architecture
> What comes next?
{{% pageinfo color="info" %}} > [Next](./cnoe.md) we'll see how we are going to do platform orchestration with CNOE!
### What comes next?
[Next](../cnoe/) we'll see how we are going to do platform orchestration with CNOE!
{{% /pageinfo %}}
## Addendum ## Addendum
@ -46,6 +44,4 @@ https://humanitec.com/reference-architectures
You remember the [capability mappings from the time before orchestration](../platforming)? Here we have a [similar setup based on Humanitecs platform engineering status ewhite paper](https://humanitec.com/whitepapers/state-of-platform-engineering-report-volume-2): You remember the [capability mappings from the time before orchestration](../platforming)? Here we have a [similar setup based on Humanitecs platform engineering status ewhite paper](https://humanitec.com/whitepapers/state-of-platform-engineering-report-volume-2):
<img src="./platform-tooling-humanitec-platform-report-2024.PNG" width="600" alt="https://humanitec.com/whitepapers/state-of-platform-engineering-report-volume-2 Whitepaper_ State of Platform Engineering Report.pdf"> ![https://humanitec.com/whitepapers/state-of-platform-engineering-report-volume-2 Whitepaper_ State of Platform Engineering Report.pdf](./4_orchestrators/platform-tooling-humanitec-platform-report-2024.PNG)

View file

@ -1,7 +1,8 @@
--- ---
title: Concepts title: Overview
weight: 1 weight: 1
description: The underlying platforming concepts of the Edge Developer Framework (EDF) solution, i.e. the problem domain description: The underlying platforming concepts of the Edge Developer Framework (EDF) solution, i.e. the problem domain
--- ---
The underlying platforming concepts of the Edge Developer Framework (EDF) solution, i.e. the problem domain

View file

@ -1,6 +1,7 @@
--- ---
title: Solution title: Overview
weight: 2 weight: 2
description: "The implemented platforming solutions of EDF, i.e. the solution domain. The documentation of all project output: Design, Building blocks, results, show cases, artifacts and so on" description: "The implemented platforming solutions of EDF, i.e. the solution domain. The documentation of all project output: Design, Building blocks, results, show cases, artifacts and so on"
--- ---
The implemented platforming solutions of EDF, i.e. the solution domain. The documentation of all project output: Design, Building blocks, results, show cases, artifacts and so on

View file

@ -1,6 +0,0 @@
---
title: Scenarios
weight: 1
description: Usage scenarios and system architecture
---

View file

@ -1,6 +1,7 @@
--- ---
title: Project title: Overview
weight: 5 weight: 5
description: How we organize work and proceed as team, which decisions we made, what outputs and outcomes we have description: How we organize work and proceed as team, which decisions we made, what outputs and outcomes we have
--- ---
How we organize work and proceed as team, which decisions we made, what outputs and outcomes we have

View file

@ -1 +1,24 @@
Run ´npx likec4 start´ to start dev server # LikeC4 architecture documentation
Run `npx likec4 start` to start dev server
## with docker and how to render/export images
// how to create/export c4 images:
// see also https://likec4.dev/tooling/cli/
docker run -it --rm --name likec4 --user node -v $PWD:/app node bash
npm install likec4
exit
docker commit likec4 likec4
docker run -it --rm --user node -v $PWD:/app -p 5173:5173 likec4 bash
// as root
npx playwright install-deps
npx playwright install
npm install likec4
// render
node@e20899c8046f:/app/content/en/docs/project/onboarding$ ./node_modules/.bin/likec4 export png -o ./images .