diff --git a/README.md b/README.md index f99478b..62fa905 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,9 @@ Telekom MMS & T-Systems, December 2024 - [📖 About the Product](#-about-the-product) - [🛠️ Application Stack](#️-application-stack) - [📖 Access our Documentation](#-access-our-documentation) + - [In our Open Sovereign Cloud](#in-our-open-sovereign-cloud) + - [In a local kind cluster](#in-a-local-kind-cluster) + - [In the Forgejo repository](#in-the-forgejo-repository) - [📝 License](#-license) --- @@ -20,7 +23,7 @@ Telekom MMS & T-Systems, December 2024 ## 📖 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. +The **E**dge **D**evelopment **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 @@ -38,19 +41,22 @@ One usecase to demonstrate the capabilities of our tool is the PetClinic Applica 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** +### 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. -- URL: https://edf-cc1.cx.fg1.ffm.osc.live/docs/edppoc/component/edp-documentation +- URL: - Username: user1 - Password: PpMpfZYICG9MRRF-3QBY2Zz1-+URYB6+-JRe -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. +### 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. +### In the Forgejo repository + +If you prefer direct access, the content of our documentation is centrally defined and maintained within the docs folder of this repository. --- diff --git a/docs/gettingstarted/user-documentation.md b/docs/gettingstarted/user-documentation.md index c17eeb2..c779ca9 100644 --- a/docs/gettingstarted/user-documentation.md +++ b/docs/gettingstarted/user-documentation.md @@ -22,6 +22,8 @@ ## 🧐 What is it? +10:40 THU + ## 📦 Main features ## ⏱️ Quick start guide