From 866dca1655f745c69e45ddca094802ed8615d157 Mon Sep 17 00:00:00 2001 From: Stephan Lo Date: Thu, 19 Dec 2024 14:28:28 +0100 Subject: [PATCH] doc(technical-documentation): initial port of technical documentation --- docs/introduction/technical-documentation.md | 7 ++++ docs/introduction/user-documentation.md | 32 +++++++++++++++++++ .../1_software-and-workloads/_index.md | 1 + .../concepts/5_platforms/CNOE/_index.md | 10 +++--- .../concepts/5_platforms/Humanitec/_index.md | 8 ++--- .../concepts/5_platforms/_index.md | 4 +++ mkdocs.yaml | 19 +++++------ 7 files changed, 63 insertions(+), 18 deletions(-) create mode 100644 docs/introduction/technical-documentation.md create mode 100644 docs/introduction/user-documentation.md diff --git a/docs/introduction/technical-documentation.md b/docs/introduction/technical-documentation.md new file mode 100644 index 0000000..910f6e2 --- /dev/null +++ b/docs/introduction/technical-documentation.md @@ -0,0 +1,7 @@ +# Technical Documentation + +## Outline + +1. Concepts + The underlying platforming concepts of the Edge Developer Framework (EDF) solution, i.e. the problem domain + diff --git a/docs/introduction/user-documentation.md b/docs/introduction/user-documentation.md new file mode 100644 index 0000000..c17eeb2 --- /dev/null +++ b/docs/introduction/user-documentation.md @@ -0,0 +1,32 @@ +# User Documentation + +## 📋 Outline +- [What is it? (short description what the software does, max 3 sentences)](#what-is-it) + - A couple of use cases (different scopes) + - Why do I need / want this? When should I pass? + - Compare with other platforms + - Compare with well-known tools (what parts of my stack / pipeline does this cover?) + - argo -> vercel + - monitoring -> data dog + - forgejo -> graphite +- [Main features (brief list of main features and enablers - why it is in the stack)](#main-features) + - what are our opinions / core principles and believes that are backed in? + - k8s > * + - Developer Portal: Backstage +- [Quick start guide](#quick-start-guide) +- [Configuration](#configuration) + - structure of the poc (where / how can I change something?) + - how does it work? (bootstrapping++) +- [Known Issues / TODOs](#known-issues) +- [References (documentation links etc...)](#references) + +## 🧐 What is it? + +## 📦 Main features + +## ⏱️ Quick start guide + +## ⚙️ Configuration + +## 🔗 References +- Technical Documentation diff --git a/docs/technical-documentation/concepts/1_software-and-workloads/_index.md b/docs/technical-documentation/concepts/1_software-and-workloads/_index.md index 85c6a6f..b694bf8 100644 --- a/docs/technical-documentation/concepts/1_software-and-workloads/_index.md +++ b/docs/technical-documentation/concepts/1_software-and-workloads/_index.md @@ -6,3 +6,4 @@ description: 'The center of everything else, the reason, driver and center of al --- +> The center of everything else, the reason, driver and center of all being: Running Code \ No newline at end of file diff --git a/docs/technical-documentation/concepts/5_platforms/CNOE/_index.md b/docs/technical-documentation/concepts/5_platforms/CNOE/_index.md index dac0b04..8af04a0 100644 --- a/docs/technical-documentation/concepts/5_platforms/CNOE/_index.md +++ b/docs/technical-documentation/concepts/5_platforms/CNOE/_index.md @@ -1,11 +1,11 @@ -+++ -title = "CNOE" -weight = 4 -+++ +--- +title: CNOE +weight: 4 +--- * https://cnoe.io/docs/intro - + > The goal for the CNOE framework is to bring together a cohort of enterprises operating at the same scale so that they can navigate their operational technology decisions together, de-risk their tooling bets, coordinate contribution, and offer guidance to large enterprises on which CNCF technologies to use together to achieve the best cloud efficiencies. ### Aussprache diff --git a/docs/technical-documentation/concepts/5_platforms/Humanitec/_index.md b/docs/technical-documentation/concepts/5_platforms/Humanitec/_index.md index 21c9e69..07be1b6 100644 --- a/docs/technical-documentation/concepts/5_platforms/Humanitec/_index.md +++ b/docs/technical-documentation/concepts/5_platforms/Humanitec/_index.md @@ -1,7 +1,7 @@ -+++ -title = "Humanitec" -weight = 4 -+++ +--- +title: Humanitec +weight: 4 +--- tbd \ No newline at end of file diff --git a/docs/technical-documentation/concepts/5_platforms/_index.md b/docs/technical-documentation/concepts/5_platforms/_index.md index 84bd16d..fe7a58b 100644 --- a/docs/technical-documentation/concepts/5_platforms/_index.md +++ b/docs/technical-documentation/concepts/5_platforms/_index.md @@ -6,3 +6,7 @@ description: Platform automation is the next level of platforming --- +* [CNOE](./CNOE/_index.md) +* [Humanitec](./Humanitec/_index.md) +* [Kratix](./Kratix/_index.md) +* [BACKstack]() \ No newline at end of file diff --git a/mkdocs.yaml b/mkdocs.yaml index d99c71e..c239f0f 100644 --- a/mkdocs.yaml +++ b/mkdocs.yaml @@ -3,9 +3,10 @@ site_description: 'EDP documentation' nav: - Home: index.md - - Overview: - - User Documentation: gettingstarted/user-documentation.md - - User Guide: + - Introduction: + - User Documentation: introduction/user-documentation.md + - Technical Documentation: introduction/technical-documentation.md + - User Documentation: - ArgoCD: userguide/argocd.md - Backstage: userguide/backstage.md - CI Workflow: userguide/ci-workflow.md @@ -17,15 +18,15 @@ nav: - OpenBAO: userguide/openbao.md - PetClinic: userguide/petclinic.md - Technical Documentation: - - Platfrom concepts: technical-documentation/concepts/_index.md - - Deployment: techdocs/deployment.md - - Development: techdocs/development.md - - Testing: techdocs/testing.md + - Platform concepts: + - 'Code: Software and Workloads': technical-documentation/concepts/1_software-and-workloads/_index.md + - Engineers: technical-documentation/concepts/2_engineering-people/_index.md + - Use Cases: technical-documentation/concepts/3_use-cases/_index.md + - Digital Platforms: technical-documentation/concepts/4_digital-platforms/_index.md + - Platform Orchestrators: technical-documentation/concepts/5_platforms/_index.md - About: - License: about/license.md - Release Notes: about/release-notes.md - - A Test doc: about/mkdocs-test.md - plugins: - techdocs-core