diff --git a/docs/technical-documentation/.pages b/docs/technical-documentation/.pages new file mode 100644 index 0000000..332b339 --- /dev/null +++ b/docs/technical-documentation/.pages @@ -0,0 +1,6 @@ +title: Technical doc +arrange: + - concepts + - architecture + - product + - project diff --git a/docs/technical-documentation/product/operations/gitops/_index.md b/docs/technical-documentation/architecture/research/gitops/_index.md similarity index 100% rename from docs/technical-documentation/product/operations/gitops/_index.md rename to docs/technical-documentation/architecture/research/gitops/_index.md diff --git a/docs/technical-documentation/product/operations/gitops/image.png b/docs/technical-documentation/architecture/research/gitops/image.png similarity index 100% rename from docs/technical-documentation/product/operations/gitops/image.png rename to docs/technical-documentation/architecture/research/gitops/image.png diff --git a/docs/technical-documentation/product/operations/orchestration/_index.md b/docs/technical-documentation/architecture/research/orchestration/_index.md similarity index 100% rename from docs/technical-documentation/product/operations/orchestration/_index.md rename to docs/technical-documentation/architecture/research/orchestration/_index.md diff --git a/docs/technical-documentation/product/operations/orchestration/image-1.png b/docs/technical-documentation/architecture/research/orchestration/image-1.png similarity index 100% rename from docs/technical-documentation/product/operations/orchestration/image-1.png rename to docs/technical-documentation/architecture/research/orchestration/image-1.png diff --git a/docs/technical-documentation/product/operations/orchestration/image.png b/docs/technical-documentation/architecture/research/orchestration/image.png similarity index 100% rename from docs/technical-documentation/product/operations/orchestration/image.png rename to docs/technical-documentation/architecture/research/orchestration/image.png diff --git a/docs/technical-documentation/concepts/.pages b/docs/technical-documentation/concepts/.pages index 73f6151..86fb01d 100644 --- a/docs/technical-documentation/concepts/.pages +++ b/docs/technical-documentation/concepts/.pages @@ -1,5 +1,6 @@ title: Concepts arrange: + - overview.md - general - customer-developer - - edp-developer \ No newline at end of file + - edp-developer diff --git a/docs/technical-documentation/concepts/edp-developer/.pages b/docs/technical-documentation/concepts/edp-developer/.pages index caa7887..1851e03 100644 --- a/docs/technical-documentation/concepts/edp-developer/.pages +++ b/docs/technical-documentation/concepts/edp-developer/.pages @@ -5,3 +5,6 @@ arrange: - edge-developer-framework.md - platforming.md - orchestrators.md + - cnoe.md + - cnoe-showtime.md + - conclusio.md diff --git a/docs/technical-documentation/concepts/edp-developer/7_conclusio/README.md b/docs/technical-documentation/concepts/edp-developer/7_conclusio/README.md deleted file mode 100644 index 769478d..0000000 --- a/docs/technical-documentation/concepts/edp-developer/7_conclusio/README.md +++ /dev/null @@ -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 . \ No newline at end of file diff --git a/docs/technical-documentation/concepts/edp-developer/6_cnoe-showtime/_index.md b/docs/technical-documentation/concepts/edp-developer/cnoe-showtime.md similarity index 100% rename from docs/technical-documentation/concepts/edp-developer/6_cnoe-showtime/_index.md rename to docs/technical-documentation/concepts/edp-developer/cnoe-showtime.md diff --git a/docs/technical-documentation/concepts/edp-developer/5_cnoe/_index.md b/docs/technical-documentation/concepts/edp-developer/cnoe.md similarity index 100% rename from docs/technical-documentation/concepts/edp-developer/5_cnoe/_index.md rename to docs/technical-documentation/concepts/edp-developer/cnoe.md diff --git a/docs/technical-documentation/concepts/edp-developer/7_conclusio/_index.md b/docs/technical-documentation/concepts/edp-developer/conclusio.md similarity index 100% rename from docs/technical-documentation/concepts/edp-developer/7_conclusio/_index.md rename to docs/technical-documentation/concepts/edp-developer/conclusio.md diff --git a/docs/technical-documentation/concepts/edp-developer/orchestrators.md b/docs/technical-documentation/concepts/edp-developer/orchestrators.md index d91a842..9358a73 100644 --- a/docs/technical-documentation/concepts/edp-developer/orchestrators.md +++ b/docs/technical-documentation/concepts/edp-developer/orchestrators.md @@ -6,7 +6,8 @@ description: Next level platforming is orchestrating platforms ## 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 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': -https://developer.humanitec.com/introduction/overview/ +![https://developer.humanitec.com/introduction/overview/](./4_orchestrators/vendor-neutral-idp-final.gif) ## 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/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 - -{{% pageinfo color="info" %}} -### What comes next? - -[Next](../cnoe/) we'll see how we are going to do platform orchestration with CNOE! -{{% /pageinfo %}} +> What comes next? +> [Next](./cnoe.md) we'll see how we are going to do platform orchestration with CNOE! ## 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): -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) diff --git a/docs/technical-documentation/concepts/_index.md b/docs/technical-documentation/concepts/overview.md similarity index 53% rename from docs/technical-documentation/concepts/_index.md rename to docs/technical-documentation/concepts/overview.md index 9d830d0..1ce92a0 100644 --- a/docs/technical-documentation/concepts/_index.md +++ b/docs/technical-documentation/concepts/overview.md @@ -1,7 +1,8 @@ --- -title: Concepts +title: Overview 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 diff --git a/docs/technical-documentation/product/_index.md b/docs/technical-documentation/product/_index.md index aaac88e..6ab69ae 100644 --- a/docs/technical-documentation/product/_index.md +++ b/docs/technical-documentation/product/_index.md @@ -1,6 +1,7 @@ --- -title: Solution +title: Overview 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" --- +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 \ No newline at end of file diff --git a/docs/technical-documentation/product/operations/_index.md b/docs/technical-documentation/product/operations/_index.md deleted file mode 100644 index a7839e3..0000000 --- a/docs/technical-documentation/product/operations/_index.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: Scenarios -weight: 1 -description: Usage scenarios and system architecture ---- - diff --git a/docs/technical-documentation/project/_index.md b/docs/technical-documentation/project/_index.md index 97f0dad..ea51e48 100644 --- a/docs/technical-documentation/project/_index.md +++ b/docs/technical-documentation/project/_index.md @@ -1,6 +1,7 @@ --- -title: Project +title: Overview weight: 5 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 \ No newline at end of file diff --git a/likec4/README.md b/likec4/README.md index dcb10cc..34ea5e1 100644 --- a/likec4/README.md +++ b/likec4/README.md @@ -1 +1,24 @@ -Run ´npx likec4 start´ to start dev server \ No newline at end of file +# 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 . \ No newline at end of file