refactor(techdoc): section technical documentation refactored. WiP - usage of plugin awesome-pages in test
1
.gitignore
vendored
Normal file
|
@ -0,0 +1 @@
|
||||||
|
node_modules
|
21
.vscode/settings.json
vendored
|
@ -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"
|
||||||
|
}
|
||||||
}
|
}
|
Before Width: | Height: | Size: 626 KiB After Width: | Height: | Size: 626 KiB |
5
docs/technical-documentation/concepts/.pages
Normal file
|
@ -0,0 +1,5 @@
|
||||||
|
title: Concepts
|
||||||
|
arrange:
|
||||||
|
- general
|
||||||
|
- customer-developer
|
||||||
|
- edp-developer
|
Before Width: | Height: | Size: 114 KiB After Width: | Height: | Size: 114 KiB |
Before Width: | Height: | Size: 114 KiB After Width: | Height: | Size: 114 KiB |
Before Width: | Height: | Size: 212 KiB After Width: | Height: | Size: 212 KiB |
Before Width: | Height: | Size: 96 KiB After Width: | Height: | Size: 96 KiB |
|
@ -0,0 +1,7 @@
|
||||||
|
title: edgeDeveloper Framework
|
||||||
|
arrange:
|
||||||
|
- storyline.md
|
||||||
|
- introduction.md
|
||||||
|
- edge-developer-framework.md
|
||||||
|
- platforming.md
|
||||||
|
- orchestrators.md
|
Before Width: | Height: | Size: 904 KiB After Width: | Height: | Size: 904 KiB |
Before Width: | Height: | Size: 37 KiB After Width: | Height: | Size: 37 KiB |
Before Width: | Height: | Size: 160 KiB After Width: | Height: | Size: 160 KiB |
Before Width: | Height: | Size: 600 KiB After Width: | Height: | Size: 600 KiB |
Before Width: | Height: | Size: 98 KiB After Width: | Height: | Size: 98 KiB |
Before Width: | Height: | Size: 723 KiB After Width: | Height: | Size: 723 KiB |
Before Width: | Height: | Size: 397 KiB After Width: | Height: | Size: 397 KiB |
Before Width: | Height: | Size: 63 KiB After Width: | Height: | Size: 63 KiB |
Before Width: | Height: | Size: 167 KiB After Width: | Height: | Size: 167 KiB |
Before Width: | Height: | Size: 120 KiB After Width: | Height: | Size: 120 KiB |
Before Width: | Height: | Size: 174 KiB After Width: | Height: | Size: 174 KiB |
Before Width: | Height: | Size: 196 KiB After Width: | Height: | Size: 196 KiB |
Before Width: | Height: | Size: 188 KiB After Width: | Height: | Size: 188 KiB |
Before Width: | Height: | Size: 243 KiB After Width: | Height: | Size: 243 KiB |
Before Width: | Height: | Size: 79 KiB After Width: | Height: | Size: 79 KiB |
Before Width: | Height: | Size: 275 KiB After Width: | Height: | Size: 275 KiB |
Before Width: | Height: | Size: 190 KiB After Width: | Height: | Size: 190 KiB |
Before Width: | Height: | Size: 66 KiB After Width: | Height: | Size: 66 KiB |
Before Width: | Height: | Size: 207 KiB After Width: | Height: | Size: 207 KiB |
Before Width: | Height: | Size: 397 KiB After Width: | Height: | Size: 397 KiB |
Before Width: | Height: | Size: 137 KiB After Width: | Height: | Size: 137 KiB |
Before Width: | Height: | Size: 85 KiB After Width: | Height: | Size: 85 KiB |
Before Width: | Height: | Size: 85 KiB After Width: | Height: | Size: 85 KiB |
Before Width: | Height: | Size: 118 KiB After Width: | Height: | Size: 118 KiB |
Before Width: | Height: | Size: 152 KiB After Width: | Height: | Size: 152 KiB |
Before Width: | Height: | Size: 372 KiB After Width: | Height: | Size: 372 KiB |
Before Width: | Height: | Size: 766 KiB After Width: | Height: | Size: 766 KiB |
Before Width: | Height: | Size: 100 KiB After Width: | Height: | Size: 100 KiB |
Before Width: | Height: | Size: 67 KiB After Width: | Height: | Size: 67 KiB |
Before Width: | Height: | Size: 55 KiB After Width: | Height: | Size: 55 KiB |
Before Width: | Height: | Size: 224 KiB After Width: | Height: | Size: 224 KiB |
|
@ -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':
|
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
|
## Declarative Platform Orchestration
|
||||||
|
|
|
@ -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!).
|
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
|
### 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"):
|
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/)
|
> 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:
|
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
|
## 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" %}}
|
{{% pageinfo color="info" %}}
|
||||||
### What comes next?
|
### 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 %}}
|
{{% /pageinfo %}}
|
||||||
|
|
||||||
## Addendum
|
## Addendum
|
|
@ -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
|
## Storyline
|
||||||
|
|
||||||
|
@ -24,5 +32,3 @@
|
||||||
3. Don't miss to further investigate and truely understand **CNOE solution**
|
3. Don't miss to further investigate and truely understand **CNOE solution**
|
||||||
|
|
||||||
## Architecture
|
## Architecture
|
||||||
|
|
||||||
|
|
Before Width: | Height: | Size: 154 KiB After Width: | Height: | Size: 154 KiB |
Before Width: | Height: | Size: 944 KiB After Width: | Height: | Size: 944 KiB |
Before Width: | Height: | Size: 160 KiB After Width: | Height: | Size: 160 KiB |
Before Width: | Height: | Size: 732 KiB After Width: | Height: | Size: 732 KiB |
Before Width: | Height: | Size: 554 KiB After Width: | Height: | Size: 554 KiB |
Before Width: | Height: | Size: 1.3 MiB After Width: | Height: | Size: 1.3 MiB |
Before Width: | Height: | Size: 51 KiB After Width: | Height: | Size: 51 KiB |
Before Width: | Height: | Size: 113 KiB After Width: | Height: | Size: 113 KiB |
Before Width: | Height: | Size: 364 KiB After Width: | Height: | Size: 364 KiB |
Before Width: | Height: | Size: 208 KiB After Width: | Height: | Size: 208 KiB |
7
docs/technical-documentation/concepts/general/_index.md
Normal 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
|
Before Width: | Height: | Size: 322 KiB After Width: | Height: | Size: 322 KiB |
Before Width: | Height: | Size: 451 KiB After Width: | Height: | Size: 451 KiB |
Before Width: | Height: | Size: 86 KiB After Width: | Height: | Size: 86 KiB |
Before Width: | Height: | Size: 76 KiB After Width: | Height: | Size: 76 KiB |