From 6c9d026c167c9228476e2b58bc73bca55591298e Mon Sep 17 00:00:00 2001 From: Stephan Lo Date: Wed, 18 Dec 2024 15:39:53 +0100 Subject: [PATCH] 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: