From 0a73aa087016b4f0b22051484af023257e891d81 Mon Sep 17 00:00:00 2001 From: Stephan Lo Date: Thu, 19 Dec 2024 14:52:10 +0100 Subject: [PATCH] doc(technical-documentation): added first port of technical documentation --- docs/gettingstarted/user-documentation.md | 34 ------------------- docs/introduction/user-documentation.md | 2 ++ .../argocd.md | 0 .../backstage.md | 0 .../ci-workflow.md | 0 .../crossplane.md | 0 .../edpbuilder.md | 0 .../forgejo.md | 0 .../grafana.md | 0 .../keycloak.md | 0 .../openbao.md | 0 .../petclinic.md | 0 mkdocs.yaml | 20 +++++------ 13 files changed, 12 insertions(+), 44 deletions(-) delete mode 100644 docs/gettingstarted/user-documentation.md rename docs/{userguide => user-documentation}/argocd.md (100%) rename docs/{userguide => user-documentation}/backstage.md (100%) rename docs/{userguide => user-documentation}/ci-workflow.md (100%) rename docs/{userguide => user-documentation}/crossplane.md (100%) rename docs/{userguide => user-documentation}/edpbuilder.md (100%) rename docs/{userguide => user-documentation}/forgejo.md (100%) rename docs/{userguide => user-documentation}/grafana.md (100%) rename docs/{userguide => user-documentation}/keycloak.md (100%) rename docs/{userguide => user-documentation}/openbao.md (100%) rename docs/{userguide => user-documentation}/petclinic.md (100%) diff --git a/docs/gettingstarted/user-documentation.md b/docs/gettingstarted/user-documentation.md deleted file mode 100644 index c779ca9..0000000 --- a/docs/gettingstarted/user-documentation.md +++ /dev/null @@ -1,34 +0,0 @@ -# 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? - -10:40 THU - -## 📦 Main features - -## ⏱️ Quick start guide - -## ⚙️ Configuration - -## 🔗 References -- Technical Documentation diff --git a/docs/introduction/user-documentation.md b/docs/introduction/user-documentation.md index c17eeb2..c779ca9 100644 --- a/docs/introduction/user-documentation.md +++ b/docs/introduction/user-documentation.md @@ -22,6 +22,8 @@ ## 🧐 What is it? +10:40 THU + ## 📦 Main features ## ⏱️ Quick start guide diff --git a/docs/userguide/argocd.md b/docs/user-documentation/argocd.md similarity index 100% rename from docs/userguide/argocd.md rename to docs/user-documentation/argocd.md diff --git a/docs/userguide/backstage.md b/docs/user-documentation/backstage.md similarity index 100% rename from docs/userguide/backstage.md rename to docs/user-documentation/backstage.md diff --git a/docs/userguide/ci-workflow.md b/docs/user-documentation/ci-workflow.md similarity index 100% rename from docs/userguide/ci-workflow.md rename to docs/user-documentation/ci-workflow.md diff --git a/docs/userguide/crossplane.md b/docs/user-documentation/crossplane.md similarity index 100% rename from docs/userguide/crossplane.md rename to docs/user-documentation/crossplane.md diff --git a/docs/userguide/edpbuilder.md b/docs/user-documentation/edpbuilder.md similarity index 100% rename from docs/userguide/edpbuilder.md rename to docs/user-documentation/edpbuilder.md diff --git a/docs/userguide/forgejo.md b/docs/user-documentation/forgejo.md similarity index 100% rename from docs/userguide/forgejo.md rename to docs/user-documentation/forgejo.md diff --git a/docs/userguide/grafana.md b/docs/user-documentation/grafana.md similarity index 100% rename from docs/userguide/grafana.md rename to docs/user-documentation/grafana.md diff --git a/docs/userguide/keycloak.md b/docs/user-documentation/keycloak.md similarity index 100% rename from docs/userguide/keycloak.md rename to docs/user-documentation/keycloak.md diff --git a/docs/userguide/openbao.md b/docs/user-documentation/openbao.md similarity index 100% rename from docs/userguide/openbao.md rename to docs/user-documentation/openbao.md diff --git a/docs/userguide/petclinic.md b/docs/user-documentation/petclinic.md similarity index 100% rename from docs/userguide/petclinic.md rename to docs/user-documentation/petclinic.md diff --git a/mkdocs.yaml b/mkdocs.yaml index c239f0f..b90ab9e 100644 --- a/mkdocs.yaml +++ b/mkdocs.yaml @@ -7,16 +7,16 @@ nav: - 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 - - Crossplane: userguide/crossplane.md - - edpbuilder: userguide/edpbuilder.md - - Forgejo: userguide/forgejo.md - - Grafana: userguide/grafana.md - - Keycloak: userguide/keycloak.md - - OpenBAO: userguide/openbao.md - - PetClinic: userguide/petclinic.md + - ArgoCD: user-documentation/argocd.md + - Backstage: user-documentation/backstage.md + - CI Workflow: user-documentation/ci-workflow.md + - Crossplane: user-documentation/crossplane.md + - edpbuilder: user-documentation/edpbuilder.md + - Forgejo: user-documentation/forgejo.md + - Grafana: user-documentation/grafana.md + - Keycloak: user-documentation/keycloak.md + - OpenBAO: user-documentation/openbao.md + - PetClinic: user-documentation/petclinic.md - Technical Documentation: - Platform concepts: - 'Code: Software and Workloads': technical-documentation/concepts/1_software-and-workloads/_index.md