refactor(techdoc): section technical documentation refactored. WiP - usage of plugin awesome-pages in test

This commit is contained in:
Stephan Lo 2025-04-03 00:04:22 +02:00
parent b623a09875
commit 65afaf047e
163 changed files with 70 additions and 17 deletions

1
.gitignore vendored Normal file
View file

@ -0,0 +1 @@
node_modules

21
.vscode/settings.json vendored
View file

@ -1,3 +1,22 @@
{
"peacock.color": "#832561"
"peacock.color": "#832561",
"workbench.colorCustomizations": {
"activityBar.activeBackground": "#ab307e",
"activityBar.background": "#ab307e",
"activityBar.foreground": "#e7e7e7",
"activityBar.inactiveForeground": "#e7e7e799",
"activityBarBadge.background": "#25320e",
"activityBarBadge.foreground": "#e7e7e7",
"commandCenter.border": "#e7e7e799",
"sash.hoverBorder": "#ab307e",
"statusBar.background": "#832561",
"statusBar.foreground": "#e7e7e7",
"statusBarItem.hoverBackground": "#ab307e",
"statusBarItem.remoteBackground": "#832561",
"statusBarItem.remoteForeground": "#e7e7e7",
"titleBar.activeBackground": "#832561",
"titleBar.activeForeground": "#e7e7e7",
"titleBar.inactiveBackground": "#83256199",
"titleBar.inactiveForeground": "#e7e7e799"
}
}

View file

@ -0,0 +1,5 @@
title: Concepts
arrange:
- general
- customer-developer
- edp-developer

View file

@ -0,0 +1,7 @@
title: edgeDeveloper Framework
arrange:
- storyline.md
- introduction.md
- edge-developer-framework.md
- platforming.md
- orchestrators.md

View file

@ -21,7 +21,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':
<img src="./vendor-neutral-idp-final.gif" width="600" alt="https://developer.humanitec.com/introduction/overview/">
<img src="./4_orchestrators/vendor-neutral-idp-final.gif" width="600" alt="https://developer.humanitec.com/introduction/overview/">
## Declarative Platform Orchestration

View file

@ -18,7 +18,7 @@ Let's start with a look into the history of platform engineering. A good startin
They create lots of [beautiful articles and insights](https://humanitec.com/blog), their own [platform products](https://humanitec.com/products/) and [basic concepts for the platform architecture](https://humanitec.com/platform-engineering) (we'll meet this later on!).
<img src="./humanitec-history.png" width="600" alt="https://platformengineering.org/blog/the-story-of-platform-engineering">
<img src="./3_platforming/humanitec-history.png" width="600" alt="https://platformengineering.org/blog/the-story-of-platform-engineering">
### Further nice reference to the raise of platforms
@ -41,7 +41,7 @@ When looking at these 'capabilities', we have CNCF itself:
There is a CNCF working group which provides the definition of [Capabilities of platforms](https://tag-app-delivery.cncf.io/whitepapers/platforms/#capabilities-of-platforms) and shows a first idea of the layered architecture of platforms as **service layer for developers** ("product and application teams"):
<img src="./platforms-def.drawio.png" width="600">
<img src="./3_platforming/platforms-def.drawio.png" width="600">
> Important: As Platform engineer also notice the [platform-eng-maturity-model](https://tag-app-delivery.cncf.io/whitepapers/platform-eng-maturity-model/)
@ -50,7 +50,7 @@ There is a CNCF working group which provides the definition of [Capabilities of
Or, in another illustration for the platform as a developer service interface, which also defines the **'Platform Engineering Team'** inbetween:
<img src="./platform-self-services.webp" width="600" alt="https://medium.com/@bijit211987/what-is-platform-engineering-and-how-it-reduce-cognitive-load-on-developers-ac7805603925">
<img src="./3_platforming/platform-self-services.webp" width="600" alt="https://medium.com/@bijit211987/what-is-platform-engineering-and-how-it-reduce-cognitive-load-on-developers-ac7805603925">
## How to set up Platforms
@ -77,7 +77,7 @@ Build or buy - this is also in pltaform engineering a tweaked discussion, which
{{% pageinfo color="info" %}}
### What comes next?
[Next](../orchestrators/) we'll see how these concepts got structured!
[Next](./orchestrators.md) we'll see how these concepts got structured!
{{% /pageinfo %}}
## Addendum

View file

@ -1,3 +1,11 @@
---
title: 'Storyline'
linktitle: Conceptual Onboarding
weight: 20
description: How to conceptually onboard onto the Edge Developer Framework (EDF) requirements and the designed solution
---
# Platform 101: Conceptual Onboarding
## Storyline
@ -24,5 +32,3 @@
3. Don't miss to further investigate and truely understand **CNOE solution**
## Architecture

View file

Before

Width:  |  Height:  |  Size: 944 KiB

After

Width:  |  Height:  |  Size: 944 KiB

View file

Before

Width:  |  Height:  |  Size: 113 KiB

After

Width:  |  Height:  |  Size: 113 KiB

View file

@ -0,0 +1,7 @@
---
title: General Concepts
weight: 1
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

Some files were not shown because too many files have changed in this diff Show more