From 65afaf047e2b83e1d91bae05b8bb4968593d741f Mon Sep 17 00:00:00 2001 From: Stephan Lo Date: Thu, 3 Apr 2025 00:04:22 +0200 Subject: [PATCH 1/2] refactor(techdoc): section technical documentation refactored. WiP - usage of plugin awesome-pages in test --- .gitignore | 1 + .vscode/settings.json | 21 +++++++++++++++++- .../architecture-IMG_20250121_163020.jpg | Bin .../decisions/0001-pipeline-tools.md | 0 .../{ => architecture}/decisions/README.md | 0 .../decisions/_adr-template.md | 0 .../design/_index.md | 0 .../decision-iam-and-edf-self-containment.md | 0 .../design/proposal-local-deployment.md | 0 .../design/proposal-stack-hydration.md | 0 .../design => }/architecture/highlevelarch.md | 0 docs/technical-documentation/concepts/.pages | 5 +++++ .../DevOps-Lifecycle-1.jpg | Bin .../customer-developer}/DevOps-Lifecycle.jpg | Bin .../customer-developer}/_index.md | 0 .../customer-developer}/devops.png | Bin .../customer-developer}/image.png | Bin .../concepts/edp-developer/.pages | 7 ++++++ .../3_platforming/humanitec-history.png | Bin .../3_platforming/platform-self-services.webp | Bin .../3_platforming}/platforms-def.drawio.png | Bin .../edp-developer}/3_platforming/teams.png | Bin .../platform-architectures.webp | Bin ...tooling-humanitec-platform-report-2024.PNG | Bin .../vendor-neutral-idp-final.gif | Bin .../edp-developer}/5_cnoe/_index.md | 0 .../5_cnoe/cnoe-architecture.png | Bin .../5_cnoe/cnoe-capabilities.png | Bin .../edp-developer}/5_cnoe/cnoe-stacks.png | Bin .../edp-developer}/6_cnoe-showtime/_index.md | 0 .../6_cnoe-showtime/image-1.png | Bin .../6_cnoe-showtime/image-10.png | Bin .../6_cnoe-showtime/image-11.png | Bin .../6_cnoe-showtime/image-12.png | Bin .../6_cnoe-showtime/image-13.png | Bin .../6_cnoe-showtime/image-14.png | Bin .../6_cnoe-showtime/image-15.png | Bin .../6_cnoe-showtime/image-16.png | Bin .../6_cnoe-showtime/image-2.png | Bin .../6_cnoe-showtime/image-3.png | Bin .../6_cnoe-showtime/image-4.png | Bin .../6_cnoe-showtime/image-5.png | Bin .../6_cnoe-showtime/image-6.png | Bin .../6_cnoe-showtime/image-7.png | Bin .../6_cnoe-showtime/image-8.png | Bin .../6_cnoe-showtime/image-9.png | Bin .../edp-developer}/6_cnoe-showtime/image.png | Bin .../edp-developer}/7_conclusio/README.md | 0 .../edp-developer}/7_conclusio/_index.md | 0 .../7_conclusio/domain-architecture.c4 | 0 .../images/layers-and-framework-engineer.png | Bin .../images/layers-and-platform-engineer.png | Bin .../7_conclusio/images/layers.png | Bin .../7_conclusio/images/modern.png | Bin .../edge-developer-framework.md} | 0 .../edp-developer/introduction.md} | 0 .../edp-developer/orchestrators.md} | 2 +- .../edp-developer/platforming.md} | 8 +++---- .../edp-developer}/storyline.md | 10 +++++++-- .../1_software-and-workloads/_index.md | 0 .../2_engineering-people/_index.md | 0 .../{ => general}/3_use-cases/_index.md | 0 .../3_use-cases/fibonacci-app_cpu-spike.png | Bin .../{ => general}/3_use-cases/image.png | Bin .../3_use-cases}/platforms-def.drawio.png | Bin .../4_digital-platforms/_index.md | 0 .../platform-components/_index.md | 0 .../cicd-pipeline/_index.md | 0 .../cicd-pipeline/cicd.drawio.png | Bin .../cicd-pipeline/review.md | 0 .../developer-portals/_index.md | 0 .../orchestrator/_index.md | 0 .../platform-components/references/_index.md | 0 .../Viktor-restaurant.png | Bin .../platform-engineering/_index.md | 0 .../platform-engineering/cortex-use-cases.png | Bin .../platform-engineering/idp.webp | Bin .../reference-architecture/_index.md | 0 .../{ => general}/5_platforms/CNOE/_index.md | 0 .../{ => general}/5_platforms/CNOE/cnoe.png | Bin .../5_platforms/CNOE/local-argocd.png | Bin .../5_platforms/CNOE/local-backstage.png | Bin .../5_platforms/Humanitec/_index.md | 0 .../{ => general}/5_platforms/_index.md | 0 .../concepts/general/_index.md | 7 ++++++ .../{solution => product}/_index.md | 0 .../CNOE-backstage-commit-history/_index.md | 0 .../components}/Backstage/_index.md | 0 .../backstage-setup-tutorial/_index.md | 0 .../Backstage/existing-plugins/_index.md | 0 .../Backstage/general-information/_index.md | 0 .../plugin-creation-tutorial/_index.md | 0 .../plugin-creation-tutorial/example_1.png | Bin .../plugin-creation-tutorial/example_2.png | Bin .../Backstage/template-creation/_index.md | 0 .../components}/CNOE/_index.md | 0 .../components}/CNOE/argocd/_index.md | 0 .../CNOE/argocd/argocd-core-components.webp | Bin .../CNOE/argocd/argocd_architecture.webp | Bin .../components}/CNOE/competitors/_index.md | 0 .../components}/CNOE/idpbuilder/_index.md | 0 .../idpbuilder/hostname-routing-proxy.png | Bin .../CNOE/idpbuilder/hostname-routing.png | Bin .../CNOE/idpbuilder/http-routing.md | 0 .../CNOE/idpbuilder/installation/_index.md | 0 .../CNOE/idpbuilder/path-routing.png | Bin .../included-backstage-templates/_index.md | 0 .../basic-argo-workflow/_index.md | 0 .../basic-kubernetes-deployment/_index.md | 0 .../components}/CNOE/verification.md | 0 .../Kube-prometheus-stack/_index.md | 0 .../components}/Loki/_index.md | 0 .../components}/Promtail/_index.md | 0 .../tools => product/components}/_index.md | 0 .../components}/crossplane/_index.md | 0 .../crossplane/provider-kind/_index.md | 0 .../provider-kind/composition.drawio | 0 .../crossplane/provider-kind/composition.png | Bin .../provider-kind/kindserver_interface.drawio | 0 .../provider-kind/kindserver_interface.png | Bin .../kindserver_provider-kind.drawio | 0 .../kindserver_provider-kind.png | Bin .../provider-kind_providerconfig.drawio | 0 .../provider-kind_providerconfig.png | Bin .../components}/kyverno-integration/_index.md | 0 .../kyverno-integration/kyverno.png | Bin .../operations}/_index.md | 0 .../operations}/bootstrapping/_index.md | 0 .../bootstrapping/backup/_index.md | 0 .../operations}/gitops/_index.md | 0 .../operations}/gitops/image.png | Bin .../edpbuilder-example-network.drawio | 0 .../edpbuilder-example-network.drawio.png | Bin .../edpbuilder-networking.drawio | 0 .../edpbuilder-networking.drawio.png | Bin .../host-to-kind-network-routing/index.md | 0 .../host-to-kind-network-routing/pings.png | Bin .../host-to-kind-network-routing/windows.png | Bin .../local-development/local-networking.md | 0 .../registry-mirror-and-ache/0-overview.md | 0 ...-registry-mirror-and-cache-proxy-theory.md | 0 ...ror-and-cache-proxy-manual-installation.md | 0 ...3-registry-mirror-and-cache-proxy-hacks.md | 0 .../img/1-container-engine.png | Bin .../img/1-image-naming-convention.png | Bin .../registry-mirror-and-ache/img/1-images.png | Bin .../img/1-linux-processes.png | Bin .../img/2-differnt-engines.png | Bin .../img/2-scenario-1-kind-mirror.png | Bin .../img/2-scenario-2-kind-cache.png | Bin .../img/2-scenario-3-docker-mirror.png | Bin .../img/2-scenario-4-docker-cache.png | Bin ...ntainer-engines-runtimes-orchestrators.png | Bin .../img/container-runtimes.png | Bin .../img/containerd-runtimes.png | Bin .../img/cri-architecture.png | Bin .../img/docker-containerd-cri-o-und-runc.png | Bin .../operations}/orchestration/_index.md | 0 .../operations}/orchestration/image-1.png | Bin .../operations}/orchestration/image.png | Bin .../project/conceptual-onboarding/_index.md | 9 -------- .../README-backstage-local.md | 16 +++++++++++++ mkdocs.yaml | 1 + 163 files changed, 70 insertions(+), 17 deletions(-) create mode 100644 .gitignore rename docs/technical-documentation/{solution/design => }/architecture/architecture-IMG_20250121_163020.jpg (100%) rename docs/technical-documentation/{ => architecture}/decisions/0001-pipeline-tools.md (100%) rename docs/technical-documentation/{ => architecture}/decisions/README.md (100%) rename docs/technical-documentation/{ => architecture}/decisions/_adr-template.md (100%) rename docs/technical-documentation/{solution => architecture}/design/_index.md (100%) rename docs/technical-documentation/{solution => architecture}/design/decision-iam-and-edf-self-containment.md (100%) rename docs/technical-documentation/{solution => architecture}/design/proposal-local-deployment.md (100%) rename docs/technical-documentation/{solution => architecture}/design/proposal-stack-hydration.md (100%) rename docs/technical-documentation/{solution/design => }/architecture/highlevelarch.md (100%) create mode 100644 docs/technical-documentation/concepts/.pages rename docs/technical-documentation/{project/intro-stakeholder-workshop => concepts/customer-developer}/DevOps-Lifecycle-1.jpg (100%) rename docs/technical-documentation/{project/intro-stakeholder-workshop => concepts/customer-developer}/DevOps-Lifecycle.jpg (100%) rename docs/technical-documentation/{project/intro-stakeholder-workshop => concepts/customer-developer}/_index.md (100%) rename docs/technical-documentation/{project/intro-stakeholder-workshop => concepts/customer-developer}/devops.png (100%) rename docs/technical-documentation/{project/intro-stakeholder-workshop => concepts/customer-developer}/image.png (100%) create mode 100644 docs/technical-documentation/concepts/edp-developer/.pages rename docs/technical-documentation/{project/conceptual-onboarding => concepts/edp-developer}/3_platforming/humanitec-history.png (100%) rename docs/technical-documentation/{project/conceptual-onboarding => concepts/edp-developer}/3_platforming/platform-self-services.webp (100%) rename docs/technical-documentation/concepts/{3_use-cases => edp-developer/3_platforming}/platforms-def.drawio.png (100%) rename docs/technical-documentation/{project/conceptual-onboarding => concepts/edp-developer}/3_platforming/teams.png (100%) rename docs/technical-documentation/{project/conceptual-onboarding => concepts/edp-developer}/4_orchestrators/platform-architectures.webp (100%) rename docs/technical-documentation/{project/conceptual-onboarding => concepts/edp-developer}/4_orchestrators/platform-tooling-humanitec-platform-report-2024.PNG (100%) rename docs/technical-documentation/{project/conceptual-onboarding => concepts/edp-developer}/4_orchestrators/vendor-neutral-idp-final.gif (100%) rename docs/technical-documentation/{project/conceptual-onboarding => concepts/edp-developer}/5_cnoe/_index.md (100%) rename docs/technical-documentation/{project/conceptual-onboarding => concepts/edp-developer}/5_cnoe/cnoe-architecture.png (100%) rename docs/technical-documentation/{project/conceptual-onboarding => concepts/edp-developer}/5_cnoe/cnoe-capabilities.png (100%) rename docs/technical-documentation/{project/conceptual-onboarding => concepts/edp-developer}/5_cnoe/cnoe-stacks.png (100%) rename docs/technical-documentation/{project/conceptual-onboarding => concepts/edp-developer}/6_cnoe-showtime/_index.md (100%) rename docs/technical-documentation/{project/conceptual-onboarding => concepts/edp-developer}/6_cnoe-showtime/image-1.png (100%) rename docs/technical-documentation/{project/conceptual-onboarding => concepts/edp-developer}/6_cnoe-showtime/image-10.png (100%) rename docs/technical-documentation/{project/conceptual-onboarding => concepts/edp-developer}/6_cnoe-showtime/image-11.png (100%) rename docs/technical-documentation/{project/conceptual-onboarding => concepts/edp-developer}/6_cnoe-showtime/image-12.png (100%) rename docs/technical-documentation/{project/conceptual-onboarding => concepts/edp-developer}/6_cnoe-showtime/image-13.png (100%) rename docs/technical-documentation/{project/conceptual-onboarding => concepts/edp-developer}/6_cnoe-showtime/image-14.png (100%) rename docs/technical-documentation/{project/conceptual-onboarding => concepts/edp-developer}/6_cnoe-showtime/image-15.png (100%) rename docs/technical-documentation/{project/conceptual-onboarding => concepts/edp-developer}/6_cnoe-showtime/image-16.png (100%) rename docs/technical-documentation/{project/conceptual-onboarding => concepts/edp-developer}/6_cnoe-showtime/image-2.png (100%) rename docs/technical-documentation/{project/conceptual-onboarding => concepts/edp-developer}/6_cnoe-showtime/image-3.png (100%) rename docs/technical-documentation/{project/conceptual-onboarding => concepts/edp-developer}/6_cnoe-showtime/image-4.png (100%) rename docs/technical-documentation/{project/conceptual-onboarding => concepts/edp-developer}/6_cnoe-showtime/image-5.png (100%) rename docs/technical-documentation/{project/conceptual-onboarding => concepts/edp-developer}/6_cnoe-showtime/image-6.png (100%) rename docs/technical-documentation/{project/conceptual-onboarding => concepts/edp-developer}/6_cnoe-showtime/image-7.png (100%) rename docs/technical-documentation/{project/conceptual-onboarding => concepts/edp-developer}/6_cnoe-showtime/image-8.png (100%) rename docs/technical-documentation/{project/conceptual-onboarding => concepts/edp-developer}/6_cnoe-showtime/image-9.png (100%) rename docs/technical-documentation/{project/conceptual-onboarding => concepts/edp-developer}/6_cnoe-showtime/image.png (100%) rename docs/technical-documentation/{project/conceptual-onboarding => concepts/edp-developer}/7_conclusio/README.md (100%) rename docs/technical-documentation/{project/conceptual-onboarding => concepts/edp-developer}/7_conclusio/_index.md (100%) rename docs/technical-documentation/{project/conceptual-onboarding => concepts/edp-developer}/7_conclusio/domain-architecture.c4 (100%) rename docs/technical-documentation/{project/conceptual-onboarding => concepts/edp-developer}/7_conclusio/images/layers-and-framework-engineer.png (100%) rename docs/technical-documentation/{project/conceptual-onboarding => concepts/edp-developer}/7_conclusio/images/layers-and-platform-engineer.png (100%) rename docs/technical-documentation/{project/conceptual-onboarding => concepts/edp-developer}/7_conclusio/images/layers.png (100%) rename docs/technical-documentation/{project/conceptual-onboarding => concepts/edp-developer}/7_conclusio/images/modern.png (100%) rename docs/technical-documentation/{project/conceptual-onboarding/2_edge-developer-framework/_index.md => concepts/edp-developer/edge-developer-framework.md} (100%) rename docs/technical-documentation/{project/conceptual-onboarding/1_intro/_index.md => concepts/edp-developer/introduction.md} (100%) rename docs/technical-documentation/{project/conceptual-onboarding/4_orchestrators/_index.md => concepts/edp-developer/orchestrators.md} (94%) rename docs/technical-documentation/{project/conceptual-onboarding/3_platforming/_index.md => concepts/edp-developer/platforming.md} (92%) rename docs/technical-documentation/{project/conceptual-onboarding => concepts/edp-developer}/storyline.md (82%) rename docs/technical-documentation/concepts/{ => general}/1_software-and-workloads/_index.md (100%) rename docs/technical-documentation/concepts/{ => general}/2_engineering-people/_index.md (100%) rename docs/technical-documentation/concepts/{ => general}/3_use-cases/_index.md (100%) rename docs/technical-documentation/concepts/{ => general}/3_use-cases/fibonacci-app_cpu-spike.png (100%) rename docs/technical-documentation/concepts/{ => general}/3_use-cases/image.png (100%) rename docs/technical-documentation/{project/conceptual-onboarding/3_platforming => concepts/general/3_use-cases}/platforms-def.drawio.png (100%) rename docs/technical-documentation/concepts/{ => general}/4_digital-platforms/_index.md (100%) rename docs/technical-documentation/concepts/{ => general}/4_digital-platforms/platform-components/_index.md (100%) rename docs/technical-documentation/concepts/{ => general}/4_digital-platforms/platform-components/cicd-pipeline/_index.md (100%) rename docs/technical-documentation/concepts/{ => general}/4_digital-platforms/platform-components/cicd-pipeline/cicd.drawio.png (100%) rename docs/technical-documentation/concepts/{ => general}/4_digital-platforms/platform-components/cicd-pipeline/review.md (100%) rename docs/technical-documentation/concepts/{ => general}/4_digital-platforms/platform-components/developer-portals/_index.md (100%) rename docs/technical-documentation/concepts/{ => general}/4_digital-platforms/platform-components/orchestrator/_index.md (100%) rename docs/technical-documentation/concepts/{ => general}/4_digital-platforms/platform-components/references/_index.md (100%) rename docs/technical-documentation/concepts/{ => general}/4_digital-platforms/platform-engineering/Viktor-restaurant.png (100%) rename docs/technical-documentation/concepts/{ => general}/4_digital-platforms/platform-engineering/_index.md (100%) rename docs/technical-documentation/concepts/{ => general}/4_digital-platforms/platform-engineering/cortex-use-cases.png (100%) rename docs/technical-documentation/concepts/{ => general}/4_digital-platforms/platform-engineering/idp.webp (100%) rename docs/technical-documentation/concepts/{ => general}/4_digital-platforms/platform-engineering/reference-architecture/_index.md (100%) rename docs/technical-documentation/concepts/{ => general}/5_platforms/CNOE/_index.md (100%) rename docs/technical-documentation/concepts/{ => general}/5_platforms/CNOE/cnoe.png (100%) rename docs/technical-documentation/concepts/{ => general}/5_platforms/CNOE/local-argocd.png (100%) rename docs/technical-documentation/concepts/{ => general}/5_platforms/CNOE/local-backstage.png (100%) rename docs/technical-documentation/concepts/{ => general}/5_platforms/Humanitec/_index.md (100%) rename docs/technical-documentation/concepts/{ => general}/5_platforms/_index.md (100%) create mode 100644 docs/technical-documentation/concepts/general/_index.md rename docs/technical-documentation/{solution => product}/_index.md (100%) rename docs/technical-documentation/{solution/tools => product/components}/Backstage/CNOE-backstage-commit-history/_index.md (100%) rename docs/technical-documentation/{solution/tools => product/components}/Backstage/_index.md (100%) rename docs/technical-documentation/{solution/tools => product/components}/Backstage/backstage-setup-tutorial/_index.md (100%) rename docs/technical-documentation/{solution/tools => product/components}/Backstage/existing-plugins/_index.md (100%) rename docs/technical-documentation/{solution/tools => product/components}/Backstage/general-information/_index.md (100%) rename docs/technical-documentation/{solution/tools => product/components}/Backstage/plugin-creation-tutorial/_index.md (100%) rename docs/technical-documentation/{solution/tools => product/components}/Backstage/plugin-creation-tutorial/example_1.png (100%) rename docs/technical-documentation/{solution/tools => product/components}/Backstage/plugin-creation-tutorial/example_2.png (100%) rename docs/technical-documentation/{solution/tools => product/components}/Backstage/template-creation/_index.md (100%) rename docs/technical-documentation/{solution/tools => product/components}/CNOE/_index.md (100%) rename docs/technical-documentation/{solution/tools => product/components}/CNOE/argocd/_index.md (100%) rename docs/technical-documentation/{solution/tools => product/components}/CNOE/argocd/argocd-core-components.webp (100%) rename docs/technical-documentation/{solution/tools => product/components}/CNOE/argocd/argocd_architecture.webp (100%) rename docs/technical-documentation/{solution/tools => product/components}/CNOE/competitors/_index.md (100%) rename docs/technical-documentation/{solution/tools => product/components}/CNOE/idpbuilder/_index.md (100%) rename docs/technical-documentation/{solution/tools => product/components}/CNOE/idpbuilder/hostname-routing-proxy.png (100%) rename docs/technical-documentation/{solution/tools => product/components}/CNOE/idpbuilder/hostname-routing.png (100%) rename docs/technical-documentation/{solution/tools => product/components}/CNOE/idpbuilder/http-routing.md (100%) rename docs/technical-documentation/{solution/tools => product/components}/CNOE/idpbuilder/installation/_index.md (100%) rename docs/technical-documentation/{solution/tools => product/components}/CNOE/idpbuilder/path-routing.png (100%) rename docs/technical-documentation/{solution/tools => product/components}/CNOE/included-backstage-templates/_index.md (100%) rename docs/technical-documentation/{solution/tools => product/components}/CNOE/included-backstage-templates/basic-argo-workflow/_index.md (100%) rename docs/technical-documentation/{solution/tools => product/components}/CNOE/included-backstage-templates/basic-kubernetes-deployment/_index.md (100%) rename docs/technical-documentation/{solution/tools => product/components}/CNOE/verification.md (100%) rename docs/technical-documentation/{solution/tools => product/components}/Kube-prometheus-stack/_index.md (100%) rename docs/technical-documentation/{solution/tools => product/components}/Loki/_index.md (100%) rename docs/technical-documentation/{solution/tools => product/components}/Promtail/_index.md (100%) rename docs/technical-documentation/{solution/tools => product/components}/_index.md (100%) rename docs/technical-documentation/{solution/tools => product/components}/crossplane/_index.md (100%) rename docs/technical-documentation/{solution/tools => product/components}/crossplane/provider-kind/_index.md (100%) rename docs/technical-documentation/{solution/tools => product/components}/crossplane/provider-kind/composition.drawio (100%) rename docs/technical-documentation/{solution/tools => product/components}/crossplane/provider-kind/composition.png (100%) rename docs/technical-documentation/{solution/tools => product/components}/crossplane/provider-kind/kindserver_interface.drawio (100%) rename docs/technical-documentation/{solution/tools => product/components}/crossplane/provider-kind/kindserver_interface.png (100%) rename docs/technical-documentation/{solution/tools => product/components}/crossplane/provider-kind/kindserver_provider-kind.drawio (100%) rename docs/technical-documentation/{solution/tools => product/components}/crossplane/provider-kind/kindserver_provider-kind.png (100%) rename docs/technical-documentation/{solution/tools => product/components}/crossplane/provider-kind/provider-kind_providerconfig.drawio (100%) rename docs/technical-documentation/{solution/tools => product/components}/crossplane/provider-kind/provider-kind_providerconfig.png (100%) rename docs/technical-documentation/{solution/tools => product/components}/kyverno-integration/_index.md (100%) rename docs/technical-documentation/{solution/tools => product/components}/kyverno-integration/kyverno.png (100%) rename docs/technical-documentation/{solution/scenarios => product/operations}/_index.md (100%) rename docs/technical-documentation/{project => product/operations}/bootstrapping/_index.md (100%) rename docs/technical-documentation/{project => product/operations}/bootstrapping/backup/_index.md (100%) rename docs/technical-documentation/{solution/scenarios => product/operations}/gitops/_index.md (100%) rename docs/technical-documentation/{solution/scenarios => product/operations}/gitops/image.png (100%) rename docs/technical-documentation/{solution/scenarios => product/operations}/local-development/edpbuilder-example-network.drawio (100%) rename docs/technical-documentation/{solution/scenarios => product/operations}/local-development/edpbuilder-example-network.drawio.png (100%) rename docs/technical-documentation/{solution/scenarios => product/operations}/local-development/edpbuilder-networking.drawio (100%) rename docs/technical-documentation/{solution/scenarios => product/operations}/local-development/edpbuilder-networking.drawio.png (100%) rename docs/technical-documentation/{solution/scenarios => product/operations}/local-development/host-to-kind-network-routing/index.md (100%) rename docs/technical-documentation/{solution/scenarios => product/operations}/local-development/host-to-kind-network-routing/pings.png (100%) rename docs/technical-documentation/{solution/scenarios => product/operations}/local-development/host-to-kind-network-routing/windows.png (100%) rename docs/technical-documentation/{solution/scenarios => product/operations}/local-development/local-networking.md (100%) rename docs/technical-documentation/{solution/scenarios => product/operations}/local-development/registry-mirror-and-ache/0-overview.md (100%) rename docs/technical-documentation/{solution/scenarios => product/operations}/local-development/registry-mirror-and-ache/1-registry-mirror-and-cache-proxy-theory.md (100%) rename docs/technical-documentation/{solution/scenarios => product/operations}/local-development/registry-mirror-and-ache/2-registry-mirror-and-cache-proxy-manual-installation.md (100%) rename docs/technical-documentation/{solution/scenarios => product/operations}/local-development/registry-mirror-and-ache/3-registry-mirror-and-cache-proxy-hacks.md (100%) rename docs/technical-documentation/{solution/scenarios => product/operations}/local-development/registry-mirror-and-ache/img/1-container-engine.png (100%) rename docs/technical-documentation/{solution/scenarios => product/operations}/local-development/registry-mirror-and-ache/img/1-image-naming-convention.png (100%) rename docs/technical-documentation/{solution/scenarios => product/operations}/local-development/registry-mirror-and-ache/img/1-images.png (100%) rename docs/technical-documentation/{solution/scenarios => product/operations}/local-development/registry-mirror-and-ache/img/1-linux-processes.png (100%) rename docs/technical-documentation/{solution/scenarios => product/operations}/local-development/registry-mirror-and-ache/img/2-differnt-engines.png (100%) rename docs/technical-documentation/{solution/scenarios => product/operations}/local-development/registry-mirror-and-ache/img/2-scenario-1-kind-mirror.png (100%) rename docs/technical-documentation/{solution/scenarios => product/operations}/local-development/registry-mirror-and-ache/img/2-scenario-2-kind-cache.png (100%) rename docs/technical-documentation/{solution/scenarios => product/operations}/local-development/registry-mirror-and-ache/img/2-scenario-3-docker-mirror.png (100%) rename docs/technical-documentation/{solution/scenarios => product/operations}/local-development/registry-mirror-and-ache/img/2-scenario-4-docker-cache.png (100%) rename docs/technical-documentation/{solution/scenarios => product/operations}/local-development/registry-mirror-and-ache/img/container-engines-runtimes-orchestrators.png (100%) rename docs/technical-documentation/{solution/scenarios => product/operations}/local-development/registry-mirror-and-ache/img/container-runtimes.png (100%) rename docs/technical-documentation/{solution/scenarios => product/operations}/local-development/registry-mirror-and-ache/img/containerd-runtimes.png (100%) rename docs/technical-documentation/{solution/scenarios => product/operations}/local-development/registry-mirror-and-ache/img/cri-architecture.png (100%) rename docs/technical-documentation/{solution/scenarios => product/operations}/local-development/registry-mirror-and-ache/img/docker-containerd-cri-o-und-runc.png (100%) rename docs/technical-documentation/{solution/scenarios => product/operations}/orchestration/_index.md (100%) rename docs/technical-documentation/{solution/scenarios => product/operations}/orchestration/image-1.png (100%) rename docs/technical-documentation/{solution/scenarios => product/operations}/orchestration/image.png (100%) delete mode 100644 docs/technical-documentation/project/conceptual-onboarding/_index.md diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b512c09 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +node_modules \ No newline at end of file diff --git a/.vscode/settings.json b/.vscode/settings.json index dabfedd..2e858b6 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -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" + } } \ No newline at end of file diff --git a/docs/technical-documentation/solution/design/architecture/architecture-IMG_20250121_163020.jpg b/docs/technical-documentation/architecture/architecture-IMG_20250121_163020.jpg similarity index 100% rename from docs/technical-documentation/solution/design/architecture/architecture-IMG_20250121_163020.jpg rename to docs/technical-documentation/architecture/architecture-IMG_20250121_163020.jpg diff --git a/docs/technical-documentation/decisions/0001-pipeline-tools.md b/docs/technical-documentation/architecture/decisions/0001-pipeline-tools.md similarity index 100% rename from docs/technical-documentation/decisions/0001-pipeline-tools.md rename to docs/technical-documentation/architecture/decisions/0001-pipeline-tools.md diff --git a/docs/technical-documentation/decisions/README.md b/docs/technical-documentation/architecture/decisions/README.md similarity index 100% rename from docs/technical-documentation/decisions/README.md rename to docs/technical-documentation/architecture/decisions/README.md diff --git a/docs/technical-documentation/decisions/_adr-template.md b/docs/technical-documentation/architecture/decisions/_adr-template.md similarity index 100% rename from docs/technical-documentation/decisions/_adr-template.md rename to docs/technical-documentation/architecture/decisions/_adr-template.md diff --git a/docs/technical-documentation/solution/design/_index.md b/docs/technical-documentation/architecture/design/_index.md similarity index 100% rename from docs/technical-documentation/solution/design/_index.md rename to docs/technical-documentation/architecture/design/_index.md diff --git a/docs/technical-documentation/solution/design/decision-iam-and-edf-self-containment.md b/docs/technical-documentation/architecture/design/decision-iam-and-edf-self-containment.md similarity index 100% rename from docs/technical-documentation/solution/design/decision-iam-and-edf-self-containment.md rename to docs/technical-documentation/architecture/design/decision-iam-and-edf-self-containment.md diff --git a/docs/technical-documentation/solution/design/proposal-local-deployment.md b/docs/technical-documentation/architecture/design/proposal-local-deployment.md similarity index 100% rename from docs/technical-documentation/solution/design/proposal-local-deployment.md rename to docs/technical-documentation/architecture/design/proposal-local-deployment.md diff --git a/docs/technical-documentation/solution/design/proposal-stack-hydration.md b/docs/technical-documentation/architecture/design/proposal-stack-hydration.md similarity index 100% rename from docs/technical-documentation/solution/design/proposal-stack-hydration.md rename to docs/technical-documentation/architecture/design/proposal-stack-hydration.md diff --git a/docs/technical-documentation/solution/design/architecture/highlevelarch.md b/docs/technical-documentation/architecture/highlevelarch.md similarity index 100% rename from docs/technical-documentation/solution/design/architecture/highlevelarch.md rename to docs/technical-documentation/architecture/highlevelarch.md diff --git a/docs/technical-documentation/concepts/.pages b/docs/technical-documentation/concepts/.pages new file mode 100644 index 0000000..73f6151 --- /dev/null +++ b/docs/technical-documentation/concepts/.pages @@ -0,0 +1,5 @@ +title: Concepts +arrange: + - general + - customer-developer + - edp-developer \ No newline at end of file diff --git a/docs/technical-documentation/project/intro-stakeholder-workshop/DevOps-Lifecycle-1.jpg b/docs/technical-documentation/concepts/customer-developer/DevOps-Lifecycle-1.jpg similarity index 100% rename from docs/technical-documentation/project/intro-stakeholder-workshop/DevOps-Lifecycle-1.jpg rename to docs/technical-documentation/concepts/customer-developer/DevOps-Lifecycle-1.jpg diff --git a/docs/technical-documentation/project/intro-stakeholder-workshop/DevOps-Lifecycle.jpg b/docs/technical-documentation/concepts/customer-developer/DevOps-Lifecycle.jpg similarity index 100% rename from docs/technical-documentation/project/intro-stakeholder-workshop/DevOps-Lifecycle.jpg rename to docs/technical-documentation/concepts/customer-developer/DevOps-Lifecycle.jpg diff --git a/docs/technical-documentation/project/intro-stakeholder-workshop/_index.md b/docs/technical-documentation/concepts/customer-developer/_index.md similarity index 100% rename from docs/technical-documentation/project/intro-stakeholder-workshop/_index.md rename to docs/technical-documentation/concepts/customer-developer/_index.md diff --git a/docs/technical-documentation/project/intro-stakeholder-workshop/devops.png b/docs/technical-documentation/concepts/customer-developer/devops.png similarity index 100% rename from docs/technical-documentation/project/intro-stakeholder-workshop/devops.png rename to docs/technical-documentation/concepts/customer-developer/devops.png diff --git a/docs/technical-documentation/project/intro-stakeholder-workshop/image.png b/docs/technical-documentation/concepts/customer-developer/image.png similarity index 100% rename from docs/technical-documentation/project/intro-stakeholder-workshop/image.png rename to docs/technical-documentation/concepts/customer-developer/image.png diff --git a/docs/technical-documentation/concepts/edp-developer/.pages b/docs/technical-documentation/concepts/edp-developer/.pages new file mode 100644 index 0000000..caa7887 --- /dev/null +++ b/docs/technical-documentation/concepts/edp-developer/.pages @@ -0,0 +1,7 @@ +title: edgeDeveloper Framework +arrange: + - storyline.md + - introduction.md + - edge-developer-framework.md + - platforming.md + - orchestrators.md diff --git a/docs/technical-documentation/project/conceptual-onboarding/3_platforming/humanitec-history.png b/docs/technical-documentation/concepts/edp-developer/3_platforming/humanitec-history.png similarity index 100% rename from docs/technical-documentation/project/conceptual-onboarding/3_platforming/humanitec-history.png rename to docs/technical-documentation/concepts/edp-developer/3_platforming/humanitec-history.png diff --git a/docs/technical-documentation/project/conceptual-onboarding/3_platforming/platform-self-services.webp b/docs/technical-documentation/concepts/edp-developer/3_platforming/platform-self-services.webp similarity index 100% rename from docs/technical-documentation/project/conceptual-onboarding/3_platforming/platform-self-services.webp rename to docs/technical-documentation/concepts/edp-developer/3_platforming/platform-self-services.webp diff --git a/docs/technical-documentation/concepts/3_use-cases/platforms-def.drawio.png b/docs/technical-documentation/concepts/edp-developer/3_platforming/platforms-def.drawio.png similarity index 100% rename from docs/technical-documentation/concepts/3_use-cases/platforms-def.drawio.png rename to docs/technical-documentation/concepts/edp-developer/3_platforming/platforms-def.drawio.png diff --git a/docs/technical-documentation/project/conceptual-onboarding/3_platforming/teams.png b/docs/technical-documentation/concepts/edp-developer/3_platforming/teams.png similarity index 100% rename from docs/technical-documentation/project/conceptual-onboarding/3_platforming/teams.png rename to docs/technical-documentation/concepts/edp-developer/3_platforming/teams.png diff --git a/docs/technical-documentation/project/conceptual-onboarding/4_orchestrators/platform-architectures.webp b/docs/technical-documentation/concepts/edp-developer/4_orchestrators/platform-architectures.webp similarity index 100% rename from docs/technical-documentation/project/conceptual-onboarding/4_orchestrators/platform-architectures.webp rename to docs/technical-documentation/concepts/edp-developer/4_orchestrators/platform-architectures.webp diff --git a/docs/technical-documentation/project/conceptual-onboarding/4_orchestrators/platform-tooling-humanitec-platform-report-2024.PNG b/docs/technical-documentation/concepts/edp-developer/4_orchestrators/platform-tooling-humanitec-platform-report-2024.PNG similarity index 100% rename from docs/technical-documentation/project/conceptual-onboarding/4_orchestrators/platform-tooling-humanitec-platform-report-2024.PNG rename to docs/technical-documentation/concepts/edp-developer/4_orchestrators/platform-tooling-humanitec-platform-report-2024.PNG diff --git a/docs/technical-documentation/project/conceptual-onboarding/4_orchestrators/vendor-neutral-idp-final.gif b/docs/technical-documentation/concepts/edp-developer/4_orchestrators/vendor-neutral-idp-final.gif similarity index 100% rename from docs/technical-documentation/project/conceptual-onboarding/4_orchestrators/vendor-neutral-idp-final.gif rename to docs/technical-documentation/concepts/edp-developer/4_orchestrators/vendor-neutral-idp-final.gif diff --git a/docs/technical-documentation/project/conceptual-onboarding/5_cnoe/_index.md b/docs/technical-documentation/concepts/edp-developer/5_cnoe/_index.md similarity index 100% rename from docs/technical-documentation/project/conceptual-onboarding/5_cnoe/_index.md rename to docs/technical-documentation/concepts/edp-developer/5_cnoe/_index.md diff --git a/docs/technical-documentation/project/conceptual-onboarding/5_cnoe/cnoe-architecture.png b/docs/technical-documentation/concepts/edp-developer/5_cnoe/cnoe-architecture.png similarity index 100% rename from docs/technical-documentation/project/conceptual-onboarding/5_cnoe/cnoe-architecture.png rename to docs/technical-documentation/concepts/edp-developer/5_cnoe/cnoe-architecture.png diff --git a/docs/technical-documentation/project/conceptual-onboarding/5_cnoe/cnoe-capabilities.png b/docs/technical-documentation/concepts/edp-developer/5_cnoe/cnoe-capabilities.png similarity index 100% rename from docs/technical-documentation/project/conceptual-onboarding/5_cnoe/cnoe-capabilities.png rename to docs/technical-documentation/concepts/edp-developer/5_cnoe/cnoe-capabilities.png diff --git a/docs/technical-documentation/project/conceptual-onboarding/5_cnoe/cnoe-stacks.png b/docs/technical-documentation/concepts/edp-developer/5_cnoe/cnoe-stacks.png similarity index 100% rename from docs/technical-documentation/project/conceptual-onboarding/5_cnoe/cnoe-stacks.png rename to docs/technical-documentation/concepts/edp-developer/5_cnoe/cnoe-stacks.png diff --git a/docs/technical-documentation/project/conceptual-onboarding/6_cnoe-showtime/_index.md b/docs/technical-documentation/concepts/edp-developer/6_cnoe-showtime/_index.md similarity index 100% rename from docs/technical-documentation/project/conceptual-onboarding/6_cnoe-showtime/_index.md rename to docs/technical-documentation/concepts/edp-developer/6_cnoe-showtime/_index.md diff --git a/docs/technical-documentation/project/conceptual-onboarding/6_cnoe-showtime/image-1.png b/docs/technical-documentation/concepts/edp-developer/6_cnoe-showtime/image-1.png similarity index 100% rename from docs/technical-documentation/project/conceptual-onboarding/6_cnoe-showtime/image-1.png rename to docs/technical-documentation/concepts/edp-developer/6_cnoe-showtime/image-1.png diff --git a/docs/technical-documentation/project/conceptual-onboarding/6_cnoe-showtime/image-10.png b/docs/technical-documentation/concepts/edp-developer/6_cnoe-showtime/image-10.png similarity index 100% rename from docs/technical-documentation/project/conceptual-onboarding/6_cnoe-showtime/image-10.png rename to docs/technical-documentation/concepts/edp-developer/6_cnoe-showtime/image-10.png diff --git a/docs/technical-documentation/project/conceptual-onboarding/6_cnoe-showtime/image-11.png b/docs/technical-documentation/concepts/edp-developer/6_cnoe-showtime/image-11.png similarity index 100% rename from docs/technical-documentation/project/conceptual-onboarding/6_cnoe-showtime/image-11.png rename to docs/technical-documentation/concepts/edp-developer/6_cnoe-showtime/image-11.png diff --git a/docs/technical-documentation/project/conceptual-onboarding/6_cnoe-showtime/image-12.png b/docs/technical-documentation/concepts/edp-developer/6_cnoe-showtime/image-12.png similarity index 100% rename from docs/technical-documentation/project/conceptual-onboarding/6_cnoe-showtime/image-12.png rename to docs/technical-documentation/concepts/edp-developer/6_cnoe-showtime/image-12.png diff --git a/docs/technical-documentation/project/conceptual-onboarding/6_cnoe-showtime/image-13.png b/docs/technical-documentation/concepts/edp-developer/6_cnoe-showtime/image-13.png similarity index 100% rename from docs/technical-documentation/project/conceptual-onboarding/6_cnoe-showtime/image-13.png rename to docs/technical-documentation/concepts/edp-developer/6_cnoe-showtime/image-13.png diff --git a/docs/technical-documentation/project/conceptual-onboarding/6_cnoe-showtime/image-14.png b/docs/technical-documentation/concepts/edp-developer/6_cnoe-showtime/image-14.png similarity index 100% rename from docs/technical-documentation/project/conceptual-onboarding/6_cnoe-showtime/image-14.png rename to docs/technical-documentation/concepts/edp-developer/6_cnoe-showtime/image-14.png diff --git a/docs/technical-documentation/project/conceptual-onboarding/6_cnoe-showtime/image-15.png b/docs/technical-documentation/concepts/edp-developer/6_cnoe-showtime/image-15.png similarity index 100% rename from docs/technical-documentation/project/conceptual-onboarding/6_cnoe-showtime/image-15.png rename to docs/technical-documentation/concepts/edp-developer/6_cnoe-showtime/image-15.png diff --git a/docs/technical-documentation/project/conceptual-onboarding/6_cnoe-showtime/image-16.png b/docs/technical-documentation/concepts/edp-developer/6_cnoe-showtime/image-16.png similarity index 100% rename from docs/technical-documentation/project/conceptual-onboarding/6_cnoe-showtime/image-16.png rename to docs/technical-documentation/concepts/edp-developer/6_cnoe-showtime/image-16.png diff --git a/docs/technical-documentation/project/conceptual-onboarding/6_cnoe-showtime/image-2.png b/docs/technical-documentation/concepts/edp-developer/6_cnoe-showtime/image-2.png similarity index 100% rename from docs/technical-documentation/project/conceptual-onboarding/6_cnoe-showtime/image-2.png rename to docs/technical-documentation/concepts/edp-developer/6_cnoe-showtime/image-2.png diff --git a/docs/technical-documentation/project/conceptual-onboarding/6_cnoe-showtime/image-3.png b/docs/technical-documentation/concepts/edp-developer/6_cnoe-showtime/image-3.png similarity index 100% rename from docs/technical-documentation/project/conceptual-onboarding/6_cnoe-showtime/image-3.png rename to docs/technical-documentation/concepts/edp-developer/6_cnoe-showtime/image-3.png diff --git a/docs/technical-documentation/project/conceptual-onboarding/6_cnoe-showtime/image-4.png b/docs/technical-documentation/concepts/edp-developer/6_cnoe-showtime/image-4.png similarity index 100% rename from docs/technical-documentation/project/conceptual-onboarding/6_cnoe-showtime/image-4.png rename to docs/technical-documentation/concepts/edp-developer/6_cnoe-showtime/image-4.png diff --git a/docs/technical-documentation/project/conceptual-onboarding/6_cnoe-showtime/image-5.png b/docs/technical-documentation/concepts/edp-developer/6_cnoe-showtime/image-5.png similarity index 100% rename from docs/technical-documentation/project/conceptual-onboarding/6_cnoe-showtime/image-5.png rename to docs/technical-documentation/concepts/edp-developer/6_cnoe-showtime/image-5.png diff --git a/docs/technical-documentation/project/conceptual-onboarding/6_cnoe-showtime/image-6.png b/docs/technical-documentation/concepts/edp-developer/6_cnoe-showtime/image-6.png similarity index 100% rename from docs/technical-documentation/project/conceptual-onboarding/6_cnoe-showtime/image-6.png rename to docs/technical-documentation/concepts/edp-developer/6_cnoe-showtime/image-6.png diff --git a/docs/technical-documentation/project/conceptual-onboarding/6_cnoe-showtime/image-7.png b/docs/technical-documentation/concepts/edp-developer/6_cnoe-showtime/image-7.png similarity index 100% rename from docs/technical-documentation/project/conceptual-onboarding/6_cnoe-showtime/image-7.png rename to docs/technical-documentation/concepts/edp-developer/6_cnoe-showtime/image-7.png diff --git a/docs/technical-documentation/project/conceptual-onboarding/6_cnoe-showtime/image-8.png b/docs/technical-documentation/concepts/edp-developer/6_cnoe-showtime/image-8.png similarity index 100% rename from docs/technical-documentation/project/conceptual-onboarding/6_cnoe-showtime/image-8.png rename to docs/technical-documentation/concepts/edp-developer/6_cnoe-showtime/image-8.png diff --git a/docs/technical-documentation/project/conceptual-onboarding/6_cnoe-showtime/image-9.png b/docs/technical-documentation/concepts/edp-developer/6_cnoe-showtime/image-9.png similarity index 100% rename from docs/technical-documentation/project/conceptual-onboarding/6_cnoe-showtime/image-9.png rename to docs/technical-documentation/concepts/edp-developer/6_cnoe-showtime/image-9.png diff --git a/docs/technical-documentation/project/conceptual-onboarding/6_cnoe-showtime/image.png b/docs/technical-documentation/concepts/edp-developer/6_cnoe-showtime/image.png similarity index 100% rename from docs/technical-documentation/project/conceptual-onboarding/6_cnoe-showtime/image.png rename to docs/technical-documentation/concepts/edp-developer/6_cnoe-showtime/image.png diff --git a/docs/technical-documentation/project/conceptual-onboarding/7_conclusio/README.md b/docs/technical-documentation/concepts/edp-developer/7_conclusio/README.md similarity index 100% rename from docs/technical-documentation/project/conceptual-onboarding/7_conclusio/README.md rename to docs/technical-documentation/concepts/edp-developer/7_conclusio/README.md diff --git a/docs/technical-documentation/project/conceptual-onboarding/7_conclusio/_index.md b/docs/technical-documentation/concepts/edp-developer/7_conclusio/_index.md similarity index 100% rename from docs/technical-documentation/project/conceptual-onboarding/7_conclusio/_index.md rename to docs/technical-documentation/concepts/edp-developer/7_conclusio/_index.md diff --git a/docs/technical-documentation/project/conceptual-onboarding/7_conclusio/domain-architecture.c4 b/docs/technical-documentation/concepts/edp-developer/7_conclusio/domain-architecture.c4 similarity index 100% rename from docs/technical-documentation/project/conceptual-onboarding/7_conclusio/domain-architecture.c4 rename to docs/technical-documentation/concepts/edp-developer/7_conclusio/domain-architecture.c4 diff --git a/docs/technical-documentation/project/conceptual-onboarding/7_conclusio/images/layers-and-framework-engineer.png b/docs/technical-documentation/concepts/edp-developer/7_conclusio/images/layers-and-framework-engineer.png similarity index 100% rename from docs/technical-documentation/project/conceptual-onboarding/7_conclusio/images/layers-and-framework-engineer.png rename to docs/technical-documentation/concepts/edp-developer/7_conclusio/images/layers-and-framework-engineer.png diff --git a/docs/technical-documentation/project/conceptual-onboarding/7_conclusio/images/layers-and-platform-engineer.png b/docs/technical-documentation/concepts/edp-developer/7_conclusio/images/layers-and-platform-engineer.png similarity index 100% rename from docs/technical-documentation/project/conceptual-onboarding/7_conclusio/images/layers-and-platform-engineer.png rename to docs/technical-documentation/concepts/edp-developer/7_conclusio/images/layers-and-platform-engineer.png diff --git a/docs/technical-documentation/project/conceptual-onboarding/7_conclusio/images/layers.png b/docs/technical-documentation/concepts/edp-developer/7_conclusio/images/layers.png similarity index 100% rename from docs/technical-documentation/project/conceptual-onboarding/7_conclusio/images/layers.png rename to docs/technical-documentation/concepts/edp-developer/7_conclusio/images/layers.png diff --git a/docs/technical-documentation/project/conceptual-onboarding/7_conclusio/images/modern.png b/docs/technical-documentation/concepts/edp-developer/7_conclusio/images/modern.png similarity index 100% rename from docs/technical-documentation/project/conceptual-onboarding/7_conclusio/images/modern.png rename to docs/technical-documentation/concepts/edp-developer/7_conclusio/images/modern.png diff --git a/docs/technical-documentation/project/conceptual-onboarding/2_edge-developer-framework/_index.md b/docs/technical-documentation/concepts/edp-developer/edge-developer-framework.md similarity index 100% rename from docs/technical-documentation/project/conceptual-onboarding/2_edge-developer-framework/_index.md rename to docs/technical-documentation/concepts/edp-developer/edge-developer-framework.md diff --git a/docs/technical-documentation/project/conceptual-onboarding/1_intro/_index.md b/docs/technical-documentation/concepts/edp-developer/introduction.md similarity index 100% rename from docs/technical-documentation/project/conceptual-onboarding/1_intro/_index.md rename to docs/technical-documentation/concepts/edp-developer/introduction.md diff --git a/docs/technical-documentation/project/conceptual-onboarding/4_orchestrators/_index.md b/docs/technical-documentation/concepts/edp-developer/orchestrators.md similarity index 94% rename from docs/technical-documentation/project/conceptual-onboarding/4_orchestrators/_index.md rename to docs/technical-documentation/concepts/edp-developer/orchestrators.md index c51b864..d91a842 100644 --- a/docs/technical-documentation/project/conceptual-onboarding/4_orchestrators/_index.md +++ b/docs/technical-documentation/concepts/edp-developer/orchestrators.md @@ -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': -https://developer.humanitec.com/introduction/overview/ +https://developer.humanitec.com/introduction/overview/ ## Declarative Platform Orchestration diff --git a/docs/technical-documentation/project/conceptual-onboarding/3_platforming/_index.md b/docs/technical-documentation/concepts/edp-developer/platforming.md similarity index 92% rename from docs/technical-documentation/project/conceptual-onboarding/3_platforming/_index.md rename to docs/technical-documentation/concepts/edp-developer/platforming.md index a94c203..1332e10 100644 --- a/docs/technical-documentation/project/conceptual-onboarding/3_platforming/_index.md +++ b/docs/technical-documentation/concepts/edp-developer/platforming.md @@ -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!). -https://platformengineering.org/blog/the-story-of-platform-engineering +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"): - + > 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: -https://medium.com/@bijit211987/what-is-platform-engineering-and-how-it-reduce-cognitive-load-on-developers-ac7805603925 +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 diff --git a/docs/technical-documentation/project/conceptual-onboarding/storyline.md b/docs/technical-documentation/concepts/edp-developer/storyline.md similarity index 82% rename from docs/technical-documentation/project/conceptual-onboarding/storyline.md rename to docs/technical-documentation/concepts/edp-developer/storyline.md index 11d2997..283c2be 100644 --- a/docs/technical-documentation/project/conceptual-onboarding/storyline.md +++ b/docs/technical-documentation/concepts/edp-developer/storyline.md @@ -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 - - diff --git a/docs/technical-documentation/concepts/1_software-and-workloads/_index.md b/docs/technical-documentation/concepts/general/1_software-and-workloads/_index.md similarity index 100% rename from docs/technical-documentation/concepts/1_software-and-workloads/_index.md rename to docs/technical-documentation/concepts/general/1_software-and-workloads/_index.md diff --git a/docs/technical-documentation/concepts/2_engineering-people/_index.md b/docs/technical-documentation/concepts/general/2_engineering-people/_index.md similarity index 100% rename from docs/technical-documentation/concepts/2_engineering-people/_index.md rename to docs/technical-documentation/concepts/general/2_engineering-people/_index.md diff --git a/docs/technical-documentation/concepts/3_use-cases/_index.md b/docs/technical-documentation/concepts/general/3_use-cases/_index.md similarity index 100% rename from docs/technical-documentation/concepts/3_use-cases/_index.md rename to docs/technical-documentation/concepts/general/3_use-cases/_index.md diff --git a/docs/technical-documentation/concepts/3_use-cases/fibonacci-app_cpu-spike.png b/docs/technical-documentation/concepts/general/3_use-cases/fibonacci-app_cpu-spike.png similarity index 100% rename from docs/technical-documentation/concepts/3_use-cases/fibonacci-app_cpu-spike.png rename to docs/technical-documentation/concepts/general/3_use-cases/fibonacci-app_cpu-spike.png diff --git a/docs/technical-documentation/concepts/3_use-cases/image.png b/docs/technical-documentation/concepts/general/3_use-cases/image.png similarity index 100% rename from docs/technical-documentation/concepts/3_use-cases/image.png rename to docs/technical-documentation/concepts/general/3_use-cases/image.png diff --git a/docs/technical-documentation/project/conceptual-onboarding/3_platforming/platforms-def.drawio.png b/docs/technical-documentation/concepts/general/3_use-cases/platforms-def.drawio.png similarity index 100% rename from docs/technical-documentation/project/conceptual-onboarding/3_platforming/platforms-def.drawio.png rename to docs/technical-documentation/concepts/general/3_use-cases/platforms-def.drawio.png diff --git a/docs/technical-documentation/concepts/4_digital-platforms/_index.md b/docs/technical-documentation/concepts/general/4_digital-platforms/_index.md similarity index 100% rename from docs/technical-documentation/concepts/4_digital-platforms/_index.md rename to docs/technical-documentation/concepts/general/4_digital-platforms/_index.md diff --git a/docs/technical-documentation/concepts/4_digital-platforms/platform-components/_index.md b/docs/technical-documentation/concepts/general/4_digital-platforms/platform-components/_index.md similarity index 100% rename from docs/technical-documentation/concepts/4_digital-platforms/platform-components/_index.md rename to docs/technical-documentation/concepts/general/4_digital-platforms/platform-components/_index.md diff --git a/docs/technical-documentation/concepts/4_digital-platforms/platform-components/cicd-pipeline/_index.md b/docs/technical-documentation/concepts/general/4_digital-platforms/platform-components/cicd-pipeline/_index.md similarity index 100% rename from docs/technical-documentation/concepts/4_digital-platforms/platform-components/cicd-pipeline/_index.md rename to docs/technical-documentation/concepts/general/4_digital-platforms/platform-components/cicd-pipeline/_index.md diff --git a/docs/technical-documentation/concepts/4_digital-platforms/platform-components/cicd-pipeline/cicd.drawio.png b/docs/technical-documentation/concepts/general/4_digital-platforms/platform-components/cicd-pipeline/cicd.drawio.png similarity index 100% rename from docs/technical-documentation/concepts/4_digital-platforms/platform-components/cicd-pipeline/cicd.drawio.png rename to docs/technical-documentation/concepts/general/4_digital-platforms/platform-components/cicd-pipeline/cicd.drawio.png diff --git a/docs/technical-documentation/concepts/4_digital-platforms/platform-components/cicd-pipeline/review.md b/docs/technical-documentation/concepts/general/4_digital-platforms/platform-components/cicd-pipeline/review.md similarity index 100% rename from docs/technical-documentation/concepts/4_digital-platforms/platform-components/cicd-pipeline/review.md rename to docs/technical-documentation/concepts/general/4_digital-platforms/platform-components/cicd-pipeline/review.md diff --git a/docs/technical-documentation/concepts/4_digital-platforms/platform-components/developer-portals/_index.md b/docs/technical-documentation/concepts/general/4_digital-platforms/platform-components/developer-portals/_index.md similarity index 100% rename from docs/technical-documentation/concepts/4_digital-platforms/platform-components/developer-portals/_index.md rename to docs/technical-documentation/concepts/general/4_digital-platforms/platform-components/developer-portals/_index.md diff --git a/docs/technical-documentation/concepts/4_digital-platforms/platform-components/orchestrator/_index.md b/docs/technical-documentation/concepts/general/4_digital-platforms/platform-components/orchestrator/_index.md similarity index 100% rename from docs/technical-documentation/concepts/4_digital-platforms/platform-components/orchestrator/_index.md rename to docs/technical-documentation/concepts/general/4_digital-platforms/platform-components/orchestrator/_index.md diff --git a/docs/technical-documentation/concepts/4_digital-platforms/platform-components/references/_index.md b/docs/technical-documentation/concepts/general/4_digital-platforms/platform-components/references/_index.md similarity index 100% rename from docs/technical-documentation/concepts/4_digital-platforms/platform-components/references/_index.md rename to docs/technical-documentation/concepts/general/4_digital-platforms/platform-components/references/_index.md diff --git a/docs/technical-documentation/concepts/4_digital-platforms/platform-engineering/Viktor-restaurant.png b/docs/technical-documentation/concepts/general/4_digital-platforms/platform-engineering/Viktor-restaurant.png similarity index 100% rename from docs/technical-documentation/concepts/4_digital-platforms/platform-engineering/Viktor-restaurant.png rename to docs/technical-documentation/concepts/general/4_digital-platforms/platform-engineering/Viktor-restaurant.png diff --git a/docs/technical-documentation/concepts/4_digital-platforms/platform-engineering/_index.md b/docs/technical-documentation/concepts/general/4_digital-platforms/platform-engineering/_index.md similarity index 100% rename from docs/technical-documentation/concepts/4_digital-platforms/platform-engineering/_index.md rename to docs/technical-documentation/concepts/general/4_digital-platforms/platform-engineering/_index.md diff --git a/docs/technical-documentation/concepts/4_digital-platforms/platform-engineering/cortex-use-cases.png b/docs/technical-documentation/concepts/general/4_digital-platforms/platform-engineering/cortex-use-cases.png similarity index 100% rename from docs/technical-documentation/concepts/4_digital-platforms/platform-engineering/cortex-use-cases.png rename to docs/technical-documentation/concepts/general/4_digital-platforms/platform-engineering/cortex-use-cases.png diff --git a/docs/technical-documentation/concepts/4_digital-platforms/platform-engineering/idp.webp b/docs/technical-documentation/concepts/general/4_digital-platforms/platform-engineering/idp.webp similarity index 100% rename from docs/technical-documentation/concepts/4_digital-platforms/platform-engineering/idp.webp rename to docs/technical-documentation/concepts/general/4_digital-platforms/platform-engineering/idp.webp diff --git a/docs/technical-documentation/concepts/4_digital-platforms/platform-engineering/reference-architecture/_index.md b/docs/technical-documentation/concepts/general/4_digital-platforms/platform-engineering/reference-architecture/_index.md similarity index 100% rename from docs/technical-documentation/concepts/4_digital-platforms/platform-engineering/reference-architecture/_index.md rename to docs/technical-documentation/concepts/general/4_digital-platforms/platform-engineering/reference-architecture/_index.md diff --git a/docs/technical-documentation/concepts/5_platforms/CNOE/_index.md b/docs/technical-documentation/concepts/general/5_platforms/CNOE/_index.md similarity index 100% rename from docs/technical-documentation/concepts/5_platforms/CNOE/_index.md rename to docs/technical-documentation/concepts/general/5_platforms/CNOE/_index.md diff --git a/docs/technical-documentation/concepts/5_platforms/CNOE/cnoe.png b/docs/technical-documentation/concepts/general/5_platforms/CNOE/cnoe.png similarity index 100% rename from docs/technical-documentation/concepts/5_platforms/CNOE/cnoe.png rename to docs/technical-documentation/concepts/general/5_platforms/CNOE/cnoe.png diff --git a/docs/technical-documentation/concepts/5_platforms/CNOE/local-argocd.png b/docs/technical-documentation/concepts/general/5_platforms/CNOE/local-argocd.png similarity index 100% rename from docs/technical-documentation/concepts/5_platforms/CNOE/local-argocd.png rename to docs/technical-documentation/concepts/general/5_platforms/CNOE/local-argocd.png diff --git a/docs/technical-documentation/concepts/5_platforms/CNOE/local-backstage.png b/docs/technical-documentation/concepts/general/5_platforms/CNOE/local-backstage.png similarity index 100% rename from docs/technical-documentation/concepts/5_platforms/CNOE/local-backstage.png rename to docs/technical-documentation/concepts/general/5_platforms/CNOE/local-backstage.png diff --git a/docs/technical-documentation/concepts/5_platforms/Humanitec/_index.md b/docs/technical-documentation/concepts/general/5_platforms/Humanitec/_index.md similarity index 100% rename from docs/technical-documentation/concepts/5_platforms/Humanitec/_index.md rename to docs/technical-documentation/concepts/general/5_platforms/Humanitec/_index.md diff --git a/docs/technical-documentation/concepts/5_platforms/_index.md b/docs/technical-documentation/concepts/general/5_platforms/_index.md similarity index 100% rename from docs/technical-documentation/concepts/5_platforms/_index.md rename to docs/technical-documentation/concepts/general/5_platforms/_index.md diff --git a/docs/technical-documentation/concepts/general/_index.md b/docs/technical-documentation/concepts/general/_index.md new file mode 100644 index 0000000..9507b5a --- /dev/null +++ b/docs/technical-documentation/concepts/general/_index.md @@ -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 diff --git a/docs/technical-documentation/solution/_index.md b/docs/technical-documentation/product/_index.md similarity index 100% rename from docs/technical-documentation/solution/_index.md rename to docs/technical-documentation/product/_index.md diff --git a/docs/technical-documentation/solution/tools/Backstage/CNOE-backstage-commit-history/_index.md b/docs/technical-documentation/product/components/Backstage/CNOE-backstage-commit-history/_index.md similarity index 100% rename from docs/technical-documentation/solution/tools/Backstage/CNOE-backstage-commit-history/_index.md rename to docs/technical-documentation/product/components/Backstage/CNOE-backstage-commit-history/_index.md diff --git a/docs/technical-documentation/solution/tools/Backstage/_index.md b/docs/technical-documentation/product/components/Backstage/_index.md similarity index 100% rename from docs/technical-documentation/solution/tools/Backstage/_index.md rename to docs/technical-documentation/product/components/Backstage/_index.md diff --git a/docs/technical-documentation/solution/tools/Backstage/backstage-setup-tutorial/_index.md b/docs/technical-documentation/product/components/Backstage/backstage-setup-tutorial/_index.md similarity index 100% rename from docs/technical-documentation/solution/tools/Backstage/backstage-setup-tutorial/_index.md rename to docs/technical-documentation/product/components/Backstage/backstage-setup-tutorial/_index.md diff --git a/docs/technical-documentation/solution/tools/Backstage/existing-plugins/_index.md b/docs/technical-documentation/product/components/Backstage/existing-plugins/_index.md similarity index 100% rename from docs/technical-documentation/solution/tools/Backstage/existing-plugins/_index.md rename to docs/technical-documentation/product/components/Backstage/existing-plugins/_index.md diff --git a/docs/technical-documentation/solution/tools/Backstage/general-information/_index.md b/docs/technical-documentation/product/components/Backstage/general-information/_index.md similarity index 100% rename from docs/technical-documentation/solution/tools/Backstage/general-information/_index.md rename to docs/technical-documentation/product/components/Backstage/general-information/_index.md diff --git a/docs/technical-documentation/solution/tools/Backstage/plugin-creation-tutorial/_index.md b/docs/technical-documentation/product/components/Backstage/plugin-creation-tutorial/_index.md similarity index 100% rename from docs/technical-documentation/solution/tools/Backstage/plugin-creation-tutorial/_index.md rename to docs/technical-documentation/product/components/Backstage/plugin-creation-tutorial/_index.md diff --git a/docs/technical-documentation/solution/tools/Backstage/plugin-creation-tutorial/example_1.png b/docs/technical-documentation/product/components/Backstage/plugin-creation-tutorial/example_1.png similarity index 100% rename from docs/technical-documentation/solution/tools/Backstage/plugin-creation-tutorial/example_1.png rename to docs/technical-documentation/product/components/Backstage/plugin-creation-tutorial/example_1.png diff --git a/docs/technical-documentation/solution/tools/Backstage/plugin-creation-tutorial/example_2.png b/docs/technical-documentation/product/components/Backstage/plugin-creation-tutorial/example_2.png similarity index 100% rename from docs/technical-documentation/solution/tools/Backstage/plugin-creation-tutorial/example_2.png rename to docs/technical-documentation/product/components/Backstage/plugin-creation-tutorial/example_2.png diff --git a/docs/technical-documentation/solution/tools/Backstage/template-creation/_index.md b/docs/technical-documentation/product/components/Backstage/template-creation/_index.md similarity index 100% rename from docs/technical-documentation/solution/tools/Backstage/template-creation/_index.md rename to docs/technical-documentation/product/components/Backstage/template-creation/_index.md diff --git a/docs/technical-documentation/solution/tools/CNOE/_index.md b/docs/technical-documentation/product/components/CNOE/_index.md similarity index 100% rename from docs/technical-documentation/solution/tools/CNOE/_index.md rename to docs/technical-documentation/product/components/CNOE/_index.md diff --git a/docs/technical-documentation/solution/tools/CNOE/argocd/_index.md b/docs/technical-documentation/product/components/CNOE/argocd/_index.md similarity index 100% rename from docs/technical-documentation/solution/tools/CNOE/argocd/_index.md rename to docs/technical-documentation/product/components/CNOE/argocd/_index.md diff --git a/docs/technical-documentation/solution/tools/CNOE/argocd/argocd-core-components.webp b/docs/technical-documentation/product/components/CNOE/argocd/argocd-core-components.webp similarity index 100% rename from docs/technical-documentation/solution/tools/CNOE/argocd/argocd-core-components.webp rename to docs/technical-documentation/product/components/CNOE/argocd/argocd-core-components.webp diff --git a/docs/technical-documentation/solution/tools/CNOE/argocd/argocd_architecture.webp b/docs/technical-documentation/product/components/CNOE/argocd/argocd_architecture.webp similarity index 100% rename from docs/technical-documentation/solution/tools/CNOE/argocd/argocd_architecture.webp rename to docs/technical-documentation/product/components/CNOE/argocd/argocd_architecture.webp diff --git a/docs/technical-documentation/solution/tools/CNOE/competitors/_index.md b/docs/technical-documentation/product/components/CNOE/competitors/_index.md similarity index 100% rename from docs/technical-documentation/solution/tools/CNOE/competitors/_index.md rename to docs/technical-documentation/product/components/CNOE/competitors/_index.md diff --git a/docs/technical-documentation/solution/tools/CNOE/idpbuilder/_index.md b/docs/technical-documentation/product/components/CNOE/idpbuilder/_index.md similarity index 100% rename from docs/technical-documentation/solution/tools/CNOE/idpbuilder/_index.md rename to docs/technical-documentation/product/components/CNOE/idpbuilder/_index.md diff --git a/docs/technical-documentation/solution/tools/CNOE/idpbuilder/hostname-routing-proxy.png b/docs/technical-documentation/product/components/CNOE/idpbuilder/hostname-routing-proxy.png similarity index 100% rename from docs/technical-documentation/solution/tools/CNOE/idpbuilder/hostname-routing-proxy.png rename to docs/technical-documentation/product/components/CNOE/idpbuilder/hostname-routing-proxy.png diff --git a/docs/technical-documentation/solution/tools/CNOE/idpbuilder/hostname-routing.png b/docs/technical-documentation/product/components/CNOE/idpbuilder/hostname-routing.png similarity index 100% rename from docs/technical-documentation/solution/tools/CNOE/idpbuilder/hostname-routing.png rename to docs/technical-documentation/product/components/CNOE/idpbuilder/hostname-routing.png diff --git a/docs/technical-documentation/solution/tools/CNOE/idpbuilder/http-routing.md b/docs/technical-documentation/product/components/CNOE/idpbuilder/http-routing.md similarity index 100% rename from docs/technical-documentation/solution/tools/CNOE/idpbuilder/http-routing.md rename to docs/technical-documentation/product/components/CNOE/idpbuilder/http-routing.md diff --git a/docs/technical-documentation/solution/tools/CNOE/idpbuilder/installation/_index.md b/docs/technical-documentation/product/components/CNOE/idpbuilder/installation/_index.md similarity index 100% rename from docs/technical-documentation/solution/tools/CNOE/idpbuilder/installation/_index.md rename to docs/technical-documentation/product/components/CNOE/idpbuilder/installation/_index.md diff --git a/docs/technical-documentation/solution/tools/CNOE/idpbuilder/path-routing.png b/docs/technical-documentation/product/components/CNOE/idpbuilder/path-routing.png similarity index 100% rename from docs/technical-documentation/solution/tools/CNOE/idpbuilder/path-routing.png rename to docs/technical-documentation/product/components/CNOE/idpbuilder/path-routing.png diff --git a/docs/technical-documentation/solution/tools/CNOE/included-backstage-templates/_index.md b/docs/technical-documentation/product/components/CNOE/included-backstage-templates/_index.md similarity index 100% rename from docs/technical-documentation/solution/tools/CNOE/included-backstage-templates/_index.md rename to docs/technical-documentation/product/components/CNOE/included-backstage-templates/_index.md diff --git a/docs/technical-documentation/solution/tools/CNOE/included-backstage-templates/basic-argo-workflow/_index.md b/docs/technical-documentation/product/components/CNOE/included-backstage-templates/basic-argo-workflow/_index.md similarity index 100% rename from docs/technical-documentation/solution/tools/CNOE/included-backstage-templates/basic-argo-workflow/_index.md rename to docs/technical-documentation/product/components/CNOE/included-backstage-templates/basic-argo-workflow/_index.md diff --git a/docs/technical-documentation/solution/tools/CNOE/included-backstage-templates/basic-kubernetes-deployment/_index.md b/docs/technical-documentation/product/components/CNOE/included-backstage-templates/basic-kubernetes-deployment/_index.md similarity index 100% rename from docs/technical-documentation/solution/tools/CNOE/included-backstage-templates/basic-kubernetes-deployment/_index.md rename to docs/technical-documentation/product/components/CNOE/included-backstage-templates/basic-kubernetes-deployment/_index.md diff --git a/docs/technical-documentation/solution/tools/CNOE/verification.md b/docs/technical-documentation/product/components/CNOE/verification.md similarity index 100% rename from docs/technical-documentation/solution/tools/CNOE/verification.md rename to docs/technical-documentation/product/components/CNOE/verification.md diff --git a/docs/technical-documentation/solution/tools/Kube-prometheus-stack/_index.md b/docs/technical-documentation/product/components/Kube-prometheus-stack/_index.md similarity index 100% rename from docs/technical-documentation/solution/tools/Kube-prometheus-stack/_index.md rename to docs/technical-documentation/product/components/Kube-prometheus-stack/_index.md diff --git a/docs/technical-documentation/solution/tools/Loki/_index.md b/docs/technical-documentation/product/components/Loki/_index.md similarity index 100% rename from docs/technical-documentation/solution/tools/Loki/_index.md rename to docs/technical-documentation/product/components/Loki/_index.md diff --git a/docs/technical-documentation/solution/tools/Promtail/_index.md b/docs/technical-documentation/product/components/Promtail/_index.md similarity index 100% rename from docs/technical-documentation/solution/tools/Promtail/_index.md rename to docs/technical-documentation/product/components/Promtail/_index.md diff --git a/docs/technical-documentation/solution/tools/_index.md b/docs/technical-documentation/product/components/_index.md similarity index 100% rename from docs/technical-documentation/solution/tools/_index.md rename to docs/technical-documentation/product/components/_index.md diff --git a/docs/technical-documentation/solution/tools/crossplane/_index.md b/docs/technical-documentation/product/components/crossplane/_index.md similarity index 100% rename from docs/technical-documentation/solution/tools/crossplane/_index.md rename to docs/technical-documentation/product/components/crossplane/_index.md diff --git a/docs/technical-documentation/solution/tools/crossplane/provider-kind/_index.md b/docs/technical-documentation/product/components/crossplane/provider-kind/_index.md similarity index 100% rename from docs/technical-documentation/solution/tools/crossplane/provider-kind/_index.md rename to docs/technical-documentation/product/components/crossplane/provider-kind/_index.md diff --git a/docs/technical-documentation/solution/tools/crossplane/provider-kind/composition.drawio b/docs/technical-documentation/product/components/crossplane/provider-kind/composition.drawio similarity index 100% rename from docs/technical-documentation/solution/tools/crossplane/provider-kind/composition.drawio rename to docs/technical-documentation/product/components/crossplane/provider-kind/composition.drawio diff --git a/docs/technical-documentation/solution/tools/crossplane/provider-kind/composition.png b/docs/technical-documentation/product/components/crossplane/provider-kind/composition.png similarity index 100% rename from docs/technical-documentation/solution/tools/crossplane/provider-kind/composition.png rename to docs/technical-documentation/product/components/crossplane/provider-kind/composition.png diff --git a/docs/technical-documentation/solution/tools/crossplane/provider-kind/kindserver_interface.drawio b/docs/technical-documentation/product/components/crossplane/provider-kind/kindserver_interface.drawio similarity index 100% rename from docs/technical-documentation/solution/tools/crossplane/provider-kind/kindserver_interface.drawio rename to docs/technical-documentation/product/components/crossplane/provider-kind/kindserver_interface.drawio diff --git a/docs/technical-documentation/solution/tools/crossplane/provider-kind/kindserver_interface.png b/docs/technical-documentation/product/components/crossplane/provider-kind/kindserver_interface.png similarity index 100% rename from docs/technical-documentation/solution/tools/crossplane/provider-kind/kindserver_interface.png rename to docs/technical-documentation/product/components/crossplane/provider-kind/kindserver_interface.png diff --git a/docs/technical-documentation/solution/tools/crossplane/provider-kind/kindserver_provider-kind.drawio b/docs/technical-documentation/product/components/crossplane/provider-kind/kindserver_provider-kind.drawio similarity index 100% rename from docs/technical-documentation/solution/tools/crossplane/provider-kind/kindserver_provider-kind.drawio rename to docs/technical-documentation/product/components/crossplane/provider-kind/kindserver_provider-kind.drawio diff --git a/docs/technical-documentation/solution/tools/crossplane/provider-kind/kindserver_provider-kind.png b/docs/technical-documentation/product/components/crossplane/provider-kind/kindserver_provider-kind.png similarity index 100% rename from docs/technical-documentation/solution/tools/crossplane/provider-kind/kindserver_provider-kind.png rename to docs/technical-documentation/product/components/crossplane/provider-kind/kindserver_provider-kind.png diff --git a/docs/technical-documentation/solution/tools/crossplane/provider-kind/provider-kind_providerconfig.drawio b/docs/technical-documentation/product/components/crossplane/provider-kind/provider-kind_providerconfig.drawio similarity index 100% rename from docs/technical-documentation/solution/tools/crossplane/provider-kind/provider-kind_providerconfig.drawio rename to docs/technical-documentation/product/components/crossplane/provider-kind/provider-kind_providerconfig.drawio diff --git a/docs/technical-documentation/solution/tools/crossplane/provider-kind/provider-kind_providerconfig.png b/docs/technical-documentation/product/components/crossplane/provider-kind/provider-kind_providerconfig.png similarity index 100% rename from docs/technical-documentation/solution/tools/crossplane/provider-kind/provider-kind_providerconfig.png rename to docs/technical-documentation/product/components/crossplane/provider-kind/provider-kind_providerconfig.png diff --git a/docs/technical-documentation/solution/tools/kyverno-integration/_index.md b/docs/technical-documentation/product/components/kyverno-integration/_index.md similarity index 100% rename from docs/technical-documentation/solution/tools/kyverno-integration/_index.md rename to docs/technical-documentation/product/components/kyverno-integration/_index.md diff --git a/docs/technical-documentation/solution/tools/kyverno-integration/kyverno.png b/docs/technical-documentation/product/components/kyverno-integration/kyverno.png similarity index 100% rename from docs/technical-documentation/solution/tools/kyverno-integration/kyverno.png rename to docs/technical-documentation/product/components/kyverno-integration/kyverno.png diff --git a/docs/technical-documentation/solution/scenarios/_index.md b/docs/technical-documentation/product/operations/_index.md similarity index 100% rename from docs/technical-documentation/solution/scenarios/_index.md rename to docs/technical-documentation/product/operations/_index.md diff --git a/docs/technical-documentation/project/bootstrapping/_index.md b/docs/technical-documentation/product/operations/bootstrapping/_index.md similarity index 100% rename from docs/technical-documentation/project/bootstrapping/_index.md rename to docs/technical-documentation/product/operations/bootstrapping/_index.md diff --git a/docs/technical-documentation/project/bootstrapping/backup/_index.md b/docs/technical-documentation/product/operations/bootstrapping/backup/_index.md similarity index 100% rename from docs/technical-documentation/project/bootstrapping/backup/_index.md rename to docs/technical-documentation/product/operations/bootstrapping/backup/_index.md diff --git a/docs/technical-documentation/solution/scenarios/gitops/_index.md b/docs/technical-documentation/product/operations/gitops/_index.md similarity index 100% rename from docs/technical-documentation/solution/scenarios/gitops/_index.md rename to docs/technical-documentation/product/operations/gitops/_index.md diff --git a/docs/technical-documentation/solution/scenarios/gitops/image.png b/docs/technical-documentation/product/operations/gitops/image.png similarity index 100% rename from docs/technical-documentation/solution/scenarios/gitops/image.png rename to docs/technical-documentation/product/operations/gitops/image.png diff --git a/docs/technical-documentation/solution/scenarios/local-development/edpbuilder-example-network.drawio b/docs/technical-documentation/product/operations/local-development/edpbuilder-example-network.drawio similarity index 100% rename from docs/technical-documentation/solution/scenarios/local-development/edpbuilder-example-network.drawio rename to docs/technical-documentation/product/operations/local-development/edpbuilder-example-network.drawio diff --git a/docs/technical-documentation/solution/scenarios/local-development/edpbuilder-example-network.drawio.png b/docs/technical-documentation/product/operations/local-development/edpbuilder-example-network.drawio.png similarity index 100% rename from docs/technical-documentation/solution/scenarios/local-development/edpbuilder-example-network.drawio.png rename to docs/technical-documentation/product/operations/local-development/edpbuilder-example-network.drawio.png diff --git a/docs/technical-documentation/solution/scenarios/local-development/edpbuilder-networking.drawio b/docs/technical-documentation/product/operations/local-development/edpbuilder-networking.drawio similarity index 100% rename from docs/technical-documentation/solution/scenarios/local-development/edpbuilder-networking.drawio rename to docs/technical-documentation/product/operations/local-development/edpbuilder-networking.drawio diff --git a/docs/technical-documentation/solution/scenarios/local-development/edpbuilder-networking.drawio.png b/docs/technical-documentation/product/operations/local-development/edpbuilder-networking.drawio.png similarity index 100% rename from docs/technical-documentation/solution/scenarios/local-development/edpbuilder-networking.drawio.png rename to docs/technical-documentation/product/operations/local-development/edpbuilder-networking.drawio.png diff --git a/docs/technical-documentation/solution/scenarios/local-development/host-to-kind-network-routing/index.md b/docs/technical-documentation/product/operations/local-development/host-to-kind-network-routing/index.md similarity index 100% rename from docs/technical-documentation/solution/scenarios/local-development/host-to-kind-network-routing/index.md rename to docs/technical-documentation/product/operations/local-development/host-to-kind-network-routing/index.md diff --git a/docs/technical-documentation/solution/scenarios/local-development/host-to-kind-network-routing/pings.png b/docs/technical-documentation/product/operations/local-development/host-to-kind-network-routing/pings.png similarity index 100% rename from docs/technical-documentation/solution/scenarios/local-development/host-to-kind-network-routing/pings.png rename to docs/technical-documentation/product/operations/local-development/host-to-kind-network-routing/pings.png diff --git a/docs/technical-documentation/solution/scenarios/local-development/host-to-kind-network-routing/windows.png b/docs/technical-documentation/product/operations/local-development/host-to-kind-network-routing/windows.png similarity index 100% rename from docs/technical-documentation/solution/scenarios/local-development/host-to-kind-network-routing/windows.png rename to docs/technical-documentation/product/operations/local-development/host-to-kind-network-routing/windows.png diff --git a/docs/technical-documentation/solution/scenarios/local-development/local-networking.md b/docs/technical-documentation/product/operations/local-development/local-networking.md similarity index 100% rename from docs/technical-documentation/solution/scenarios/local-development/local-networking.md rename to docs/technical-documentation/product/operations/local-development/local-networking.md diff --git a/docs/technical-documentation/solution/scenarios/local-development/registry-mirror-and-ache/0-overview.md b/docs/technical-documentation/product/operations/local-development/registry-mirror-and-ache/0-overview.md similarity index 100% rename from docs/technical-documentation/solution/scenarios/local-development/registry-mirror-and-ache/0-overview.md rename to docs/technical-documentation/product/operations/local-development/registry-mirror-and-ache/0-overview.md diff --git a/docs/technical-documentation/solution/scenarios/local-development/registry-mirror-and-ache/1-registry-mirror-and-cache-proxy-theory.md b/docs/technical-documentation/product/operations/local-development/registry-mirror-and-ache/1-registry-mirror-and-cache-proxy-theory.md similarity index 100% rename from docs/technical-documentation/solution/scenarios/local-development/registry-mirror-and-ache/1-registry-mirror-and-cache-proxy-theory.md rename to docs/technical-documentation/product/operations/local-development/registry-mirror-and-ache/1-registry-mirror-and-cache-proxy-theory.md diff --git a/docs/technical-documentation/solution/scenarios/local-development/registry-mirror-and-ache/2-registry-mirror-and-cache-proxy-manual-installation.md b/docs/technical-documentation/product/operations/local-development/registry-mirror-and-ache/2-registry-mirror-and-cache-proxy-manual-installation.md similarity index 100% rename from docs/technical-documentation/solution/scenarios/local-development/registry-mirror-and-ache/2-registry-mirror-and-cache-proxy-manual-installation.md rename to docs/technical-documentation/product/operations/local-development/registry-mirror-and-ache/2-registry-mirror-and-cache-proxy-manual-installation.md diff --git a/docs/technical-documentation/solution/scenarios/local-development/registry-mirror-and-ache/3-registry-mirror-and-cache-proxy-hacks.md b/docs/technical-documentation/product/operations/local-development/registry-mirror-and-ache/3-registry-mirror-and-cache-proxy-hacks.md similarity index 100% rename from docs/technical-documentation/solution/scenarios/local-development/registry-mirror-and-ache/3-registry-mirror-and-cache-proxy-hacks.md rename to docs/technical-documentation/product/operations/local-development/registry-mirror-and-ache/3-registry-mirror-and-cache-proxy-hacks.md diff --git a/docs/technical-documentation/solution/scenarios/local-development/registry-mirror-and-ache/img/1-container-engine.png b/docs/technical-documentation/product/operations/local-development/registry-mirror-and-ache/img/1-container-engine.png similarity index 100% rename from docs/technical-documentation/solution/scenarios/local-development/registry-mirror-and-ache/img/1-container-engine.png rename to docs/technical-documentation/product/operations/local-development/registry-mirror-and-ache/img/1-container-engine.png diff --git a/docs/technical-documentation/solution/scenarios/local-development/registry-mirror-and-ache/img/1-image-naming-convention.png b/docs/technical-documentation/product/operations/local-development/registry-mirror-and-ache/img/1-image-naming-convention.png similarity index 100% rename from docs/technical-documentation/solution/scenarios/local-development/registry-mirror-and-ache/img/1-image-naming-convention.png rename to docs/technical-documentation/product/operations/local-development/registry-mirror-and-ache/img/1-image-naming-convention.png diff --git a/docs/technical-documentation/solution/scenarios/local-development/registry-mirror-and-ache/img/1-images.png b/docs/technical-documentation/product/operations/local-development/registry-mirror-and-ache/img/1-images.png similarity index 100% rename from docs/technical-documentation/solution/scenarios/local-development/registry-mirror-and-ache/img/1-images.png rename to docs/technical-documentation/product/operations/local-development/registry-mirror-and-ache/img/1-images.png diff --git a/docs/technical-documentation/solution/scenarios/local-development/registry-mirror-and-ache/img/1-linux-processes.png b/docs/technical-documentation/product/operations/local-development/registry-mirror-and-ache/img/1-linux-processes.png similarity index 100% rename from docs/technical-documentation/solution/scenarios/local-development/registry-mirror-and-ache/img/1-linux-processes.png rename to docs/technical-documentation/product/operations/local-development/registry-mirror-and-ache/img/1-linux-processes.png diff --git a/docs/technical-documentation/solution/scenarios/local-development/registry-mirror-and-ache/img/2-differnt-engines.png b/docs/technical-documentation/product/operations/local-development/registry-mirror-and-ache/img/2-differnt-engines.png similarity index 100% rename from docs/technical-documentation/solution/scenarios/local-development/registry-mirror-and-ache/img/2-differnt-engines.png rename to docs/technical-documentation/product/operations/local-development/registry-mirror-and-ache/img/2-differnt-engines.png diff --git a/docs/technical-documentation/solution/scenarios/local-development/registry-mirror-and-ache/img/2-scenario-1-kind-mirror.png b/docs/technical-documentation/product/operations/local-development/registry-mirror-and-ache/img/2-scenario-1-kind-mirror.png similarity index 100% rename from docs/technical-documentation/solution/scenarios/local-development/registry-mirror-and-ache/img/2-scenario-1-kind-mirror.png rename to docs/technical-documentation/product/operations/local-development/registry-mirror-and-ache/img/2-scenario-1-kind-mirror.png diff --git a/docs/technical-documentation/solution/scenarios/local-development/registry-mirror-and-ache/img/2-scenario-2-kind-cache.png b/docs/technical-documentation/product/operations/local-development/registry-mirror-and-ache/img/2-scenario-2-kind-cache.png similarity index 100% rename from docs/technical-documentation/solution/scenarios/local-development/registry-mirror-and-ache/img/2-scenario-2-kind-cache.png rename to docs/technical-documentation/product/operations/local-development/registry-mirror-and-ache/img/2-scenario-2-kind-cache.png diff --git a/docs/technical-documentation/solution/scenarios/local-development/registry-mirror-and-ache/img/2-scenario-3-docker-mirror.png b/docs/technical-documentation/product/operations/local-development/registry-mirror-and-ache/img/2-scenario-3-docker-mirror.png similarity index 100% rename from docs/technical-documentation/solution/scenarios/local-development/registry-mirror-and-ache/img/2-scenario-3-docker-mirror.png rename to docs/technical-documentation/product/operations/local-development/registry-mirror-and-ache/img/2-scenario-3-docker-mirror.png diff --git a/docs/technical-documentation/solution/scenarios/local-development/registry-mirror-and-ache/img/2-scenario-4-docker-cache.png b/docs/technical-documentation/product/operations/local-development/registry-mirror-and-ache/img/2-scenario-4-docker-cache.png similarity index 100% rename from docs/technical-documentation/solution/scenarios/local-development/registry-mirror-and-ache/img/2-scenario-4-docker-cache.png rename to docs/technical-documentation/product/operations/local-development/registry-mirror-and-ache/img/2-scenario-4-docker-cache.png diff --git a/docs/technical-documentation/solution/scenarios/local-development/registry-mirror-and-ache/img/container-engines-runtimes-orchestrators.png b/docs/technical-documentation/product/operations/local-development/registry-mirror-and-ache/img/container-engines-runtimes-orchestrators.png similarity index 100% rename from docs/technical-documentation/solution/scenarios/local-development/registry-mirror-and-ache/img/container-engines-runtimes-orchestrators.png rename to docs/technical-documentation/product/operations/local-development/registry-mirror-and-ache/img/container-engines-runtimes-orchestrators.png diff --git a/docs/technical-documentation/solution/scenarios/local-development/registry-mirror-and-ache/img/container-runtimes.png b/docs/technical-documentation/product/operations/local-development/registry-mirror-and-ache/img/container-runtimes.png similarity index 100% rename from docs/technical-documentation/solution/scenarios/local-development/registry-mirror-and-ache/img/container-runtimes.png rename to docs/technical-documentation/product/operations/local-development/registry-mirror-and-ache/img/container-runtimes.png diff --git a/docs/technical-documentation/solution/scenarios/local-development/registry-mirror-and-ache/img/containerd-runtimes.png b/docs/technical-documentation/product/operations/local-development/registry-mirror-and-ache/img/containerd-runtimes.png similarity index 100% rename from docs/technical-documentation/solution/scenarios/local-development/registry-mirror-and-ache/img/containerd-runtimes.png rename to docs/technical-documentation/product/operations/local-development/registry-mirror-and-ache/img/containerd-runtimes.png diff --git a/docs/technical-documentation/solution/scenarios/local-development/registry-mirror-and-ache/img/cri-architecture.png b/docs/technical-documentation/product/operations/local-development/registry-mirror-and-ache/img/cri-architecture.png similarity index 100% rename from docs/technical-documentation/solution/scenarios/local-development/registry-mirror-and-ache/img/cri-architecture.png rename to docs/technical-documentation/product/operations/local-development/registry-mirror-and-ache/img/cri-architecture.png diff --git a/docs/technical-documentation/solution/scenarios/local-development/registry-mirror-and-ache/img/docker-containerd-cri-o-und-runc.png b/docs/technical-documentation/product/operations/local-development/registry-mirror-and-ache/img/docker-containerd-cri-o-und-runc.png similarity index 100% rename from docs/technical-documentation/solution/scenarios/local-development/registry-mirror-and-ache/img/docker-containerd-cri-o-und-runc.png rename to docs/technical-documentation/product/operations/local-development/registry-mirror-and-ache/img/docker-containerd-cri-o-und-runc.png diff --git a/docs/technical-documentation/solution/scenarios/orchestration/_index.md b/docs/technical-documentation/product/operations/orchestration/_index.md similarity index 100% rename from docs/technical-documentation/solution/scenarios/orchestration/_index.md rename to docs/technical-documentation/product/operations/orchestration/_index.md diff --git a/docs/technical-documentation/solution/scenarios/orchestration/image-1.png b/docs/technical-documentation/product/operations/orchestration/image-1.png similarity index 100% rename from docs/technical-documentation/solution/scenarios/orchestration/image-1.png rename to docs/technical-documentation/product/operations/orchestration/image-1.png diff --git a/docs/technical-documentation/solution/scenarios/orchestration/image.png b/docs/technical-documentation/product/operations/orchestration/image.png similarity index 100% rename from docs/technical-documentation/solution/scenarios/orchestration/image.png rename to docs/technical-documentation/product/operations/orchestration/image.png diff --git a/docs/technical-documentation/project/conceptual-onboarding/_index.md b/docs/technical-documentation/project/conceptual-onboarding/_index.md deleted file mode 100644 index 52cb204..0000000 --- a/docs/technical-documentation/project/conceptual-onboarding/_index.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: 'Platform 101: Conceptual Onboarding ' -linktitle: Conceptual Onboarding -weight: 20 -description: How to conceptually onboard onto the Edge Developer Framework (EDF) requirements and the designed solution ---- - - - diff --git a/live-preview-integration/README-backstage-local.md b/live-preview-integration/README-backstage-local.md index 9d19c71..7ef3ffb 100644 --- a/live-preview-integration/README-backstage-local.md +++ b/live-preview-integration/README-backstage-local.md @@ -57,3 +57,19 @@ rm -rf tmp devbox init devbox add yarn nodejs ``` + +## Troubleshooting + +### When npm package download hangs + +```bash +# install lcocally +npm install @techdocs/cli +node_modules/@techdocs/cli/bin/techdocs-cli serve +``` + +### verbosity level + +```bash + npx --loglevel silly techdocs-cli serve -v + ``` \ No newline at end of file diff --git a/mkdocs.yaml b/mkdocs.yaml index c2061ee..7a6e510 100644 --- a/mkdocs.yaml +++ b/mkdocs.yaml @@ -5,3 +5,4 @@ site_description: 'EDP documentation' plugins: - techdocs-core + - awesome-pages \ No newline at end of file From c8695eb4036ee71eaa8f10642f090ae8383d0773 Mon Sep 17 00:00:00 2001 From: Stephan Lo Date: Wed, 9 Apr 2025 23:25:31 +0200 Subject: [PATCH 2/2] refactor(technical-documentation): first itration finished. can be pushed as mkdocs-awesome-pages-plugin is now implemented in backstage-edp --- docs/technical-documentation/.pages | 6 +++++ .../research}/gitops/_index.md | 0 .../research}/gitops/image.png | Bin .../research}/orchestration/_index.md | 0 .../research}/orchestration/image-1.png | Bin .../research}/orchestration/image.png | Bin docs/technical-documentation/concepts/.pages | 3 ++- .../concepts/edp-developer/.pages | 3 +++ .../edp-developer/7_conclusio/README.md | 18 ------------- .../_index.md => cnoe-showtime.md} | 0 .../{5_cnoe/_index.md => cnoe.md} | 0 .../{7_conclusio/_index.md => conclusio.md} | 0 .../concepts/edp-developer/orchestrators.md | 20 ++++++-------- .../concepts/{_index.md => overview.md} | 3 ++- .../technical-documentation/product/_index.md | 3 ++- .../product/operations/_index.md | 6 ----- .../technical-documentation/project/_index.md | 3 ++- likec4/README.md | 25 +++++++++++++++++- 18 files changed, 49 insertions(+), 41 deletions(-) create mode 100644 docs/technical-documentation/.pages rename docs/technical-documentation/{product/operations => architecture/research}/gitops/_index.md (100%) rename docs/technical-documentation/{product/operations => architecture/research}/gitops/image.png (100%) rename docs/technical-documentation/{product/operations => architecture/research}/orchestration/_index.md (100%) rename docs/technical-documentation/{product/operations => architecture/research}/orchestration/image-1.png (100%) rename docs/technical-documentation/{product/operations => architecture/research}/orchestration/image.png (100%) delete mode 100644 docs/technical-documentation/concepts/edp-developer/7_conclusio/README.md rename docs/technical-documentation/concepts/edp-developer/{6_cnoe-showtime/_index.md => cnoe-showtime.md} (100%) rename docs/technical-documentation/concepts/edp-developer/{5_cnoe/_index.md => cnoe.md} (100%) rename docs/technical-documentation/concepts/edp-developer/{7_conclusio/_index.md => conclusio.md} (100%) rename docs/technical-documentation/concepts/{_index.md => overview.md} (53%) delete mode 100644 docs/technical-documentation/product/operations/_index.md 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