From c291f80713c3a0c5aeae965cf6fce077d1469e4e Mon Sep 17 00:00:00 2001 From: Stephan Lo Date: Wed, 18 Dec 2024 14:58:35 +0100 Subject: [PATCH 01/11] wip nav --- mkdocs.yaml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/mkdocs.yaml b/mkdocs.yaml index 615d18b..7c91804 100644 --- a/mkdocs.yaml +++ b/mkdocs.yaml @@ -1,10 +1,11 @@ -site_name: eDFDoc -site_description: 'eDF PoC documentation' +site_name: EDFDoc +site_description: 'EDP documentation' nav: - Getting Started: - User Documentation: 'gettingstarted/user-documentation.md' - User Guide: + - ArgoCD: 'userguide/argocd.md' - OpenBAO: 'userguide/openbao.md' - CI Workflow: 'userguide/ci-workflow.md' - Technical Documentation: From 0888db9f29b30d45fe9edc7f1d8eaf44b26f2a88 Mon Sep 17 00:00:00 2001 From: Stephan Lo Date: Wed, 18 Dec 2024 15:01:04 +0100 Subject: [PATCH 02/11] update site name from EDFDoc to EDPDoc --- mkdocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkdocs.yaml b/mkdocs.yaml index 7c91804..7043750 100644 --- a/mkdocs.yaml +++ b/mkdocs.yaml @@ -1,4 +1,4 @@ -site_name: EDFDoc +site_name: EDPDoc site_description: 'EDP documentation' nav: From 04289d11e1f4a04d97973c8ef81bc3bf4dd84869 Mon Sep 17 00:00:00 2001 From: Stephan Lo Date: Wed, 18 Dec 2024 15:13:42 +0100 Subject: [PATCH 03/11] add link to README in index.md --- docs/index.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/index.md b/docs/index.md index 1e26380..5b65f77 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,3 +1,6 @@ # Getting Started Main entry point + + +{!../README.md!} \ No newline at end of file From a0d65d1a09e4b3a7633819c87009fe8ff19412d7 Mon Sep 17 00:00:00 2001 From: Stephan Lo Date: Wed, 18 Dec 2024 15:17:18 +0100 Subject: [PATCH 04/11] add docs-url annotation to catalog-info.yaml --- edp-backstage-integration/catalog-info.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/edp-backstage-integration/catalog-info.yaml b/edp-backstage-integration/catalog-info.yaml index 4d2917b..36dc7d4 100644 --- a/edp-backstage-integration/catalog-info.yaml +++ b/edp-backstage-integration/catalog-info.yaml @@ -6,6 +6,7 @@ metadata: description: This component represents the documentation for our project. annotations: backstage.io/techdocs-ref: dir:.. + backstage.io/docs-url: ../README.md tags: - documentation - docs From 9acc97880bebcfc60229684918e86b4368c297fa Mon Sep 17 00:00:00 2001 From: Stephan Lo Date: Wed, 18 Dec 2024 15:23:14 +0100 Subject: [PATCH 05/11] fix: update README link in catalog-info.yaml and remove unnecessary line in index.md --- docs/index.md | 2 -- edp-backstage-integration/catalog-info.yaml | 2 +- 2 files changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/index.md b/docs/index.md index 5b65f77..f24f83b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,5 +2,3 @@ Main entry point - -{!../README.md!} \ No newline at end of file diff --git a/edp-backstage-integration/catalog-info.yaml b/edp-backstage-integration/catalog-info.yaml index 36dc7d4..c7f48dc 100644 --- a/edp-backstage-integration/catalog-info.yaml +++ b/edp-backstage-integration/catalog-info.yaml @@ -6,7 +6,7 @@ metadata: description: This component represents the documentation for our project. annotations: backstage.io/techdocs-ref: dir:.. - backstage.io/docs-url: ../README.md + backstage.io/docs-url: ./README.md tags: - documentation - docs From 30023b23a09cba6c68c87cb1b9c1672230bd0a07 Mon Sep 17 00:00:00 2001 From: Stephan Lo Date: Wed, 18 Dec 2024 15:26:35 +0100 Subject: [PATCH 06/11] feat: add README.md for EDP Release 'PoC' and update docs-url in catalog-info.yaml --- docs/README.md | 55 +++++++++++++++++++++ edp-backstage-integration/catalog-info.yaml | 2 +- 2 files changed, 56 insertions(+), 1 deletion(-) create mode 100644 docs/README.md diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..39f37b4 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,55 @@ +# 🌟 EdgeDeveloperPlatform - EDP Release 'PoC' + +Telekom MMS & T-Systems, December 2024 + +> **Tagline:** Change the way we work with IDP's. + +--- + +## 📋 Table of Contents + +- [🌟 EdgeDeveloperPlatform - EDP Release 'PoC'](#-edgedeveloperplatform---edp-release-poc) + - [📋 Table of Contents](#-table-of-contents) + - [📖 About the Product](#-about-the-product) + - [🛠️ Application Stack](#️-application-stack) + - [📖 Access our Documentation](#-access-our-documentation) + - [📝 License](#-license) + +--- + +## 📖 About the Product + +**edpbuilder** is a tool to quickly instantiate and manage **I**nternal **D**eveloper **P**latform's (**IDP**s). +The **E**dge **D**eveloper **P**latform Builder(**edp**builder) can easily setup a Kubenetes cluster (local kind cluster or OSC instance) and deploy tools to manage the Kubernetes resources and the software lifecicle of an application. +One usecase to demonstrate the capabilities of our tool is the PetClinic Application. (LINK) + +### 🛠️ Application Stack + +- **Version-Control:** Forgejo +- **CI:** Forgejo Actions +- **CD:** ArgoCD +- **Monitoring:** Grafana, Prometheus, Loki, Promtail +- **SSO:** Keycloak +- **Developer Portal:** Backstage +- **Secret-Management:** OpenBao, external-secrets +- **Infrastructur-Provisioning:** Crossplane + +## 📖 Access our Documentation + +Our documentation is designed to be easily accessible regardless of your environment. Here are three primary ways to view it: + +1. **in Our Open Sovereign Cloud** + Our documentation can be easily accessed through a Backstage instance hosted on our Open Sovereign Cloud (OSC). Simply log in to our OSC Backstage platform to read through the documentation. + +2. **in a local kind Cluster** + Using the edpbuilder, you can set up a local IDP that comes with a Backstage instance containing the documentation. + *[How to set up a local IDP on a kind cluster](docs/userguide/edpbuilder.md)* + +3. **Forgejo Repository** + If you prefer direct access, the content of our documentation is centrally defined and maintained within the docs folder of this repository. + +--- + +## 📝 License + +[LICENSE] diff --git a/edp-backstage-integration/catalog-info.yaml b/edp-backstage-integration/catalog-info.yaml index c7f48dc..bc59258 100644 --- a/edp-backstage-integration/catalog-info.yaml +++ b/edp-backstage-integration/catalog-info.yaml @@ -6,7 +6,7 @@ metadata: description: This component represents the documentation for our project. annotations: backstage.io/techdocs-ref: dir:.. - backstage.io/docs-url: ./README.md + backstage.io/docs-url: ./docs/README.md tags: - documentation - docs From 3ebe6041508f3b58736504fec677c5332e371059 Mon Sep 17 00:00:00 2001 From: Stephan Lo Date: Wed, 18 Dec 2024 15:29:57 +0100 Subject: [PATCH 07/11] ren --- docs/{index.md => ---index.md---} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/{index.md => ---index.md---} (100%) diff --git a/docs/index.md b/docs/---index.md--- similarity index 100% rename from docs/index.md rename to docs/---index.md--- From 2f8eac5452537747b251cadfd796b79c35105c20 Mon Sep 17 00:00:00 2001 From: Stephan Lo Date: Wed, 18 Dec 2024 15:37:25 +0100 Subject: [PATCH 08/11] fix: update navigation in mkdocs.yaml to reflect new structure --- mkdocs.yaml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/mkdocs.yaml b/mkdocs.yaml index 7043750..202c9b4 100644 --- a/mkdocs.yaml +++ b/mkdocs.yaml @@ -2,7 +2,8 @@ site_name: EDPDoc site_description: 'EDP documentation' nav: - - Getting Started: + - Home: '../README.md' + - Overview: - User Documentation: 'gettingstarted/user-documentation.md' - User Guide: - ArgoCD: 'userguide/argocd.md' From 6c9d026c167c9228476e2b58bc73bca55591298e Mon Sep 17 00:00:00 2001 From: Stephan Lo Date: Wed, 18 Dec 2024 15:39:53 +0100 Subject: [PATCH 09/11] refactor: remove old README.md and index.md files, update mkdocs.yaml navigation --- docs/---index.md--- | 4 ---- docs/README.md | 55 --------------------------------------------- docs/index.md | 1 + mkdocs.yaml | 2 +- 4 files changed, 2 insertions(+), 60 deletions(-) delete mode 100644 docs/---index.md--- delete mode 100644 docs/README.md create mode 120000 docs/index.md diff --git a/docs/---index.md--- b/docs/---index.md--- deleted file mode 100644 index f24f83b..0000000 --- a/docs/---index.md--- +++ /dev/null @@ -1,4 +0,0 @@ -# Getting Started - -Main entry point - diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index 39f37b4..0000000 --- a/docs/README.md +++ /dev/null @@ -1,55 +0,0 @@ -# 🌟 EdgeDeveloperPlatform - EDP Release 'PoC' - -Telekom MMS & T-Systems, December 2024 - -> **Tagline:** Change the way we work with IDP's. - ---- - -## 📋 Table of Contents - -- [🌟 EdgeDeveloperPlatform - EDP Release 'PoC'](#-edgedeveloperplatform---edp-release-poc) - - [📋 Table of Contents](#-table-of-contents) - - [📖 About the Product](#-about-the-product) - - [🛠️ Application Stack](#️-application-stack) - - [📖 Access our Documentation](#-access-our-documentation) - - [📝 License](#-license) - ---- - -## 📖 About the Product - -**edpbuilder** is a tool to quickly instantiate and manage **I**nternal **D**eveloper **P**latform's (**IDP**s). -The **E**dge **D**eveloper **P**latform Builder(**edp**builder) can easily setup a Kubenetes cluster (local kind cluster or OSC instance) and deploy tools to manage the Kubernetes resources and the software lifecicle of an application. -One usecase to demonstrate the capabilities of our tool is the PetClinic Application. (LINK) - -### 🛠️ Application Stack - -- **Version-Control:** Forgejo -- **CI:** Forgejo Actions -- **CD:** ArgoCD -- **Monitoring:** Grafana, Prometheus, Loki, Promtail -- **SSO:** Keycloak -- **Developer Portal:** Backstage -- **Secret-Management:** OpenBao, external-secrets -- **Infrastructur-Provisioning:** Crossplane - -## 📖 Access our Documentation - -Our documentation is designed to be easily accessible regardless of your environment. Here are three primary ways to view it: - -1. **in Our Open Sovereign Cloud** - Our documentation can be easily accessed through a Backstage instance hosted on our Open Sovereign Cloud (OSC). Simply log in to our OSC Backstage platform to read through the documentation. - -2. **in a local kind Cluster** - Using the edpbuilder, you can set up a local IDP that comes with a Backstage instance containing the documentation. - *[How to set up a local IDP on a kind cluster](docs/userguide/edpbuilder.md)* - -3. **Forgejo Repository** - If you prefer direct access, the content of our documentation is centrally defined and maintained within the docs folder of this repository. - ---- - -## 📝 License - -[LICENSE] diff --git a/docs/index.md b/docs/index.md new file mode 120000 index 0000000..32d46ee --- /dev/null +++ b/docs/index.md @@ -0,0 +1 @@ +../README.md \ No newline at end of file diff --git a/mkdocs.yaml b/mkdocs.yaml index 202c9b4..bdbfbc2 100644 --- a/mkdocs.yaml +++ b/mkdocs.yaml @@ -2,7 +2,7 @@ site_name: EDPDoc site_description: 'EDP documentation' nav: - - Home: '../README.md' + - Home: 'README.md' - Overview: - User Documentation: 'gettingstarted/user-documentation.md' - User Guide: From f86ce821bc50eec0f742b460cf3cbcac629e0b41 Mon Sep 17 00:00:00 2001 From: Stephan Lo Date: Wed, 18 Dec 2024 15:41:10 +0100 Subject: [PATCH 10/11] fix: update mkdocs.yaml navigation to use correct file references --- mkdocs.yaml | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/mkdocs.yaml b/mkdocs.yaml index bdbfbc2..84e32c8 100644 --- a/mkdocs.yaml +++ b/mkdocs.yaml @@ -2,18 +2,18 @@ site_name: EDPDoc site_description: 'EDP documentation' nav: - - Home: 'README.md' + - Home: index.md - Overview: - - User Documentation: 'gettingstarted/user-documentation.md' + - User Documentation: gettingstarted/user-documentation.md - User Guide: - - ArgoCD: 'userguide/argocd.md' - - OpenBAO: 'userguide/openbao.md' - - CI Workflow: 'userguide/ci-workflow.md' + - ArgoCD: userguide/argocd.md + - OpenBAO: userguide/openbao.md + - CI Workflow: userguide/ci-workflow.md - Technical Documentation: - - Architecture: 'techdocs/architecture.md' - - Deployment: 'techdocs/deployment.md' - - Development: 'techdocs/development.md' - - Testing: 'techdocs/testing.md' + - Architecture: techdocs/architecture.md + - Deployment: techdocs/deployment.md + - Development: techdocs/development.md + - Testing: techdocs/testing.md - About: - License: about/license.md - Release Notes: about/release-notes.md From 91ee6313cc3ae5772233245b3f1d28b02eca51f4 Mon Sep 17 00:00:00 2001 From: Stephan Lo Date: Wed, 18 Dec 2024 15:45:45 +0100 Subject: [PATCH 11/11] fix: remove outdated docs-url reference in catalog-info.yaml --- edp-backstage-integration/catalog-info.yaml | 1 - 1 file changed, 1 deletion(-) diff --git a/edp-backstage-integration/catalog-info.yaml b/edp-backstage-integration/catalog-info.yaml index bc59258..4d2917b 100644 --- a/edp-backstage-integration/catalog-info.yaml +++ b/edp-backstage-integration/catalog-info.yaml @@ -6,7 +6,6 @@ metadata: description: This component represents the documentation for our project. annotations: backstage.io/techdocs-ref: dir:.. - backstage.io/docs-url: ./docs/README.md tags: - documentation - docs