From 4ed21ee54d3a2f229ee9cfbe449a03bb9bb4167c Mon Sep 17 00:00:00 2001 From: Stephan Lo Date: Sun, 29 Sep 2024 12:20:35 +0200 Subject: [PATCH] refactor(ipceicis-460-cnoe-deep-dive): top level documenation hierarchy refoctored to three entries concepts, solurion, project --- .../concepts/1_software-and-workloads/_index.md | 8 ++++++++ .../docs/concepts/2_engineering-people/_index.md | 7 +++++++ .../3_use-cases}/_index.md | 13 +++++-------- .../3_use-cases}/image.png | Bin .../3_use-cases}/platforms-def.drawio.png | Bin .../docs/concepts/4_digital-platforms/_index.md | 13 +++++++++++++ .../platform-components/_index.md | 0 .../developer-portals/_index.md | 0 .../platform-components/orchestrator/_index.md | 0 .../platform-engineering/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 .../5_platforms}/CNOE/_index.md | 0 .../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 content/en/docs/concepts/5_platforms/_index.md | 8 ++++++++ content/en/docs/concepts/_index.md | 7 +++++++ content/en/docs/platforms/_index.md | 15 --------------- content/en/docs/solution/_index.md | 8 ++++++++ .../tools/Backstage/Exsisting Plugins/_index.md | 0 .../Backstage/General Information/_index.md | 0 .../{ => solution}/tools/Backstage/_index.md | 0 .../tools/CNOE-competitors/_index.md | 0 content/en/docs/{ => solution}/tools/_index.md | 0 .../{ => solution}/tools/idpbuilder/_index.md | 0 .../tools/idpbuilder/installation/_index.md | 0 30 files changed, 56 insertions(+), 23 deletions(-) create mode 100644 content/en/docs/concepts/1_software-and-workloads/_index.md create mode 100644 content/en/docs/concepts/2_engineering-people/_index.md rename content/en/docs/{use-cases => concepts/3_use-cases}/_index.md (91%) rename content/en/docs/{use-cases => concepts/3_use-cases}/image.png (100%) rename content/en/docs/{use-cases => concepts/3_use-cases}/platforms-def.drawio.png (100%) create mode 100644 content/en/docs/concepts/4_digital-platforms/_index.md rename content/en/docs/{ => concepts/4_digital-platforms}/platform-components/_index.md (100%) rename content/en/docs/{ => concepts/4_digital-platforms}/platform-components/developer-portals/_index.md (100%) rename content/en/docs/{ => concepts/4_digital-platforms}/platform-components/orchestrator/_index.md (100%) rename content/en/docs/{ => concepts/4_digital-platforms}/platform-engineering/Viktor-restaurant.png (100%) rename content/en/docs/{ => concepts/4_digital-platforms}/platform-engineering/_index.md (100%) rename content/en/docs/{ => concepts/4_digital-platforms}/platform-engineering/cortex-use-cases.png (100%) rename content/en/docs/{ => concepts/4_digital-platforms}/platform-engineering/idp.webp (100%) rename content/en/docs/{ => concepts/4_digital-platforms}/platform-engineering/reference-architecture/_index.md (100%) rename content/en/docs/{platforms => concepts/5_platforms}/CNOE/_index.md (100%) rename content/en/docs/{platforms => concepts/5_platforms}/CNOE/cnoe.png (100%) rename content/en/docs/{platforms => concepts/5_platforms}/CNOE/local-argocd.png (100%) rename content/en/docs/{platforms => concepts/5_platforms}/CNOE/local-backstage.png (100%) rename content/en/docs/{platforms => concepts/5_platforms}/Humanitec/_index.md (100%) create mode 100644 content/en/docs/concepts/5_platforms/_index.md create mode 100644 content/en/docs/concepts/_index.md delete mode 100644 content/en/docs/platforms/_index.md create mode 100644 content/en/docs/solution/_index.md rename content/en/docs/{ => solution}/tools/Backstage/Exsisting Plugins/_index.md (100%) rename content/en/docs/{ => solution}/tools/Backstage/General Information/_index.md (100%) rename content/en/docs/{ => solution}/tools/Backstage/_index.md (100%) rename content/en/docs/{ => solution}/tools/CNOE-competitors/_index.md (100%) rename content/en/docs/{ => solution}/tools/_index.md (100%) rename content/en/docs/{ => solution}/tools/idpbuilder/_index.md (100%) rename content/en/docs/{ => solution}/tools/idpbuilder/installation/_index.md (100%) diff --git a/content/en/docs/concepts/1_software-and-workloads/_index.md b/content/en/docs/concepts/1_software-and-workloads/_index.md new file mode 100644 index 0000000..85c6a6f --- /dev/null +++ b/content/en/docs/concepts/1_software-and-workloads/_index.md @@ -0,0 +1,8 @@ +--- +title: 'Code: Software and Workloads' +linktitle: Code +weight: 1 +description: 'The center of everything else, the reason, driver and center of all being: Running Code' +--- + + diff --git a/content/en/docs/concepts/2_engineering-people/_index.md b/content/en/docs/concepts/2_engineering-people/_index.md new file mode 100644 index 0000000..999dd9a --- /dev/null +++ b/content/en/docs/concepts/2_engineering-people/_index.md @@ -0,0 +1,7 @@ +--- +title: Engineers +weight: 2 +description: 'Our clients: People creating code and bringing it to live - and their habits and contexts' +--- + + diff --git a/content/en/docs/use-cases/_index.md b/content/en/docs/concepts/3_use-cases/_index.md similarity index 91% rename from content/en/docs/use-cases/_index.md rename to content/en/docs/concepts/3_use-cases/_index.md index 42c1dca..c27f9d9 100644 --- a/content/en/docs/use-cases/_index.md +++ b/content/en/docs/concepts/3_use-cases/_index.md @@ -1,11 +1,8 @@ -+++ -archetype = "chapter" -title = "Use Cases" -weight = 2 -[params] - author = 'stephan.lo@telekom.de' - date = '2024-07-30' -+++ +--- +title: Use Cases +weight: 2 +description: The golden paths in the engineers and product development domain +--- ## Rationale diff --git a/content/en/docs/use-cases/image.png b/content/en/docs/concepts/3_use-cases/image.png similarity index 100% rename from content/en/docs/use-cases/image.png rename to content/en/docs/concepts/3_use-cases/image.png diff --git a/content/en/docs/use-cases/platforms-def.drawio.png b/content/en/docs/concepts/3_use-cases/platforms-def.drawio.png similarity index 100% rename from content/en/docs/use-cases/platforms-def.drawio.png rename to content/en/docs/concepts/3_use-cases/platforms-def.drawio.png diff --git a/content/en/docs/concepts/4_digital-platforms/_index.md b/content/en/docs/concepts/4_digital-platforms/_index.md new file mode 100644 index 0000000..d0145e7 --- /dev/null +++ b/content/en/docs/concepts/4_digital-platforms/_index.md @@ -0,0 +1,13 @@ +--- +title: (Digital) Platforms +linktitle: Platforms +weight: 4 +description: Platforming is the discipline to provide full sophisticated golden paths to the engineers. It's the next level of DevOps. +--- + +## Surveys + +* [10-best-internal-developer-platforms-to-consider-in-2023/](https://www.qovery.com/blog/10-best-internal-developer-platforms-to-consider-in-2023/) + + + diff --git a/content/en/docs/platform-components/_index.md b/content/en/docs/concepts/4_digital-platforms/platform-components/_index.md similarity index 100% rename from content/en/docs/platform-components/_index.md rename to content/en/docs/concepts/4_digital-platforms/platform-components/_index.md diff --git a/content/en/docs/platform-components/developer-portals/_index.md b/content/en/docs/concepts/4_digital-platforms/platform-components/developer-portals/_index.md similarity index 100% rename from content/en/docs/platform-components/developer-portals/_index.md rename to content/en/docs/concepts/4_digital-platforms/platform-components/developer-portals/_index.md diff --git a/content/en/docs/platform-components/orchestrator/_index.md b/content/en/docs/concepts/4_digital-platforms/platform-components/orchestrator/_index.md similarity index 100% rename from content/en/docs/platform-components/orchestrator/_index.md rename to content/en/docs/concepts/4_digital-platforms/platform-components/orchestrator/_index.md diff --git a/content/en/docs/platform-engineering/Viktor-restaurant.png b/content/en/docs/concepts/4_digital-platforms/platform-engineering/Viktor-restaurant.png similarity index 100% rename from content/en/docs/platform-engineering/Viktor-restaurant.png rename to content/en/docs/concepts/4_digital-platforms/platform-engineering/Viktor-restaurant.png diff --git a/content/en/docs/platform-engineering/_index.md b/content/en/docs/concepts/4_digital-platforms/platform-engineering/_index.md similarity index 100% rename from content/en/docs/platform-engineering/_index.md rename to content/en/docs/concepts/4_digital-platforms/platform-engineering/_index.md diff --git a/content/en/docs/platform-engineering/cortex-use-cases.png b/content/en/docs/concepts/4_digital-platforms/platform-engineering/cortex-use-cases.png similarity index 100% rename from content/en/docs/platform-engineering/cortex-use-cases.png rename to content/en/docs/concepts/4_digital-platforms/platform-engineering/cortex-use-cases.png diff --git a/content/en/docs/platform-engineering/idp.webp b/content/en/docs/concepts/4_digital-platforms/platform-engineering/idp.webp similarity index 100% rename from content/en/docs/platform-engineering/idp.webp rename to content/en/docs/concepts/4_digital-platforms/platform-engineering/idp.webp diff --git a/content/en/docs/platform-engineering/reference-architecture/_index.md b/content/en/docs/concepts/4_digital-platforms/platform-engineering/reference-architecture/_index.md similarity index 100% rename from content/en/docs/platform-engineering/reference-architecture/_index.md rename to content/en/docs/concepts/4_digital-platforms/platform-engineering/reference-architecture/_index.md diff --git a/content/en/docs/platforms/CNOE/_index.md b/content/en/docs/concepts/5_platforms/CNOE/_index.md similarity index 100% rename from content/en/docs/platforms/CNOE/_index.md rename to content/en/docs/concepts/5_platforms/CNOE/_index.md diff --git a/content/en/docs/platforms/CNOE/cnoe.png b/content/en/docs/concepts/5_platforms/CNOE/cnoe.png similarity index 100% rename from content/en/docs/platforms/CNOE/cnoe.png rename to content/en/docs/concepts/5_platforms/CNOE/cnoe.png diff --git a/content/en/docs/platforms/CNOE/local-argocd.png b/content/en/docs/concepts/5_platforms/CNOE/local-argocd.png similarity index 100% rename from content/en/docs/platforms/CNOE/local-argocd.png rename to content/en/docs/concepts/5_platforms/CNOE/local-argocd.png diff --git a/content/en/docs/platforms/CNOE/local-backstage.png b/content/en/docs/concepts/5_platforms/CNOE/local-backstage.png similarity index 100% rename from content/en/docs/platforms/CNOE/local-backstage.png rename to content/en/docs/concepts/5_platforms/CNOE/local-backstage.png diff --git a/content/en/docs/platforms/Humanitec/_index.md b/content/en/docs/concepts/5_platforms/Humanitec/_index.md similarity index 100% rename from content/en/docs/platforms/Humanitec/_index.md rename to content/en/docs/concepts/5_platforms/Humanitec/_index.md diff --git a/content/en/docs/concepts/5_platforms/_index.md b/content/en/docs/concepts/5_platforms/_index.md new file mode 100644 index 0000000..84bd16d --- /dev/null +++ b/content/en/docs/concepts/5_platforms/_index.md @@ -0,0 +1,8 @@ +--- +title: Platform Orchestrators +linktitle: Orchestrators +weight: 5 +description: Platform automation is the next level of platforming +--- + + diff --git a/content/en/docs/concepts/_index.md b/content/en/docs/concepts/_index.md new file mode 100644 index 0000000..9d9620d --- /dev/null +++ b/content/en/docs/concepts/_index.md @@ -0,0 +1,7 @@ +--- +title: Concepts +weight: 1 +description: The underlying platfroming concepts of the EDF solution, i.e. the problem domain +--- + + diff --git a/content/en/docs/platforms/_index.md b/content/en/docs/platforms/_index.md deleted file mode 100644 index 87c4bc8..0000000 --- a/content/en/docs/platforms/_index.md +++ /dev/null @@ -1,15 +0,0 @@ -+++ -title = "Platforms" -weight = 4 -[params] - author = 'stephan.lo@telekom.de' - date = '2024-07-30' -+++ - -List of existing IDPs. - -## Surveys - -* [10-best-internal-developer-platforms-to-consider-in-2023/](https://www.qovery.com/blog/10-best-internal-developer-platforms-to-consider-in-2023/) - - diff --git a/content/en/docs/solution/_index.md b/content/en/docs/solution/_index.md new file mode 100644 index 0000000..7afabb6 --- /dev/null +++ b/content/en/docs/solution/_index.md @@ -0,0 +1,8 @@ +--- +title: Solution +weight: 2 +description: The underlying platfroming concepts of the EDF solution, the solution domain +--- + +All output the project created: Design, Building blocks, results, show cases, artifacts + diff --git a/content/en/docs/tools/Backstage/Exsisting Plugins/_index.md b/content/en/docs/solution/tools/Backstage/Exsisting Plugins/_index.md similarity index 100% rename from content/en/docs/tools/Backstage/Exsisting Plugins/_index.md rename to content/en/docs/solution/tools/Backstage/Exsisting Plugins/_index.md diff --git a/content/en/docs/tools/Backstage/General Information/_index.md b/content/en/docs/solution/tools/Backstage/General Information/_index.md similarity index 100% rename from content/en/docs/tools/Backstage/General Information/_index.md rename to content/en/docs/solution/tools/Backstage/General Information/_index.md diff --git a/content/en/docs/tools/Backstage/_index.md b/content/en/docs/solution/tools/Backstage/_index.md similarity index 100% rename from content/en/docs/tools/Backstage/_index.md rename to content/en/docs/solution/tools/Backstage/_index.md diff --git a/content/en/docs/tools/CNOE-competitors/_index.md b/content/en/docs/solution/tools/CNOE-competitors/_index.md similarity index 100% rename from content/en/docs/tools/CNOE-competitors/_index.md rename to content/en/docs/solution/tools/CNOE-competitors/_index.md diff --git a/content/en/docs/tools/_index.md b/content/en/docs/solution/tools/_index.md similarity index 100% rename from content/en/docs/tools/_index.md rename to content/en/docs/solution/tools/_index.md diff --git a/content/en/docs/tools/idpbuilder/_index.md b/content/en/docs/solution/tools/idpbuilder/_index.md similarity index 100% rename from content/en/docs/tools/idpbuilder/_index.md rename to content/en/docs/solution/tools/idpbuilder/_index.md diff --git a/content/en/docs/tools/idpbuilder/installation/_index.md b/content/en/docs/solution/tools/idpbuilder/installation/_index.md similarity index 100% rename from content/en/docs/tools/idpbuilder/installation/_index.md rename to content/en/docs/solution/tools/idpbuilder/installation/_index.md