diff --git a/README.md b/README.md index 9038b2b..bfbb932 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# 🌟 EdgeDeveloperPlatform - EDP Release 'PoC' +# 🌟 EdgeDeveloperPlatform - EDP Release 'PoC' - Franz Telekom MMS & T-Systems, December 2024 @@ -10,12 +10,13 @@ This file describes how you can read the EDP documentation and run and use the p ## 📋 Table of Contents -- [🌟 eDF Release 'PoC'](#-edf-release-poc) +- [🌟 EdgeDeveloperPlatform - EDP Release 'PoC'](#-edgedeveloperplatform---edp-release-poc) - [📋 Table of Contents](#-table-of-contents) - [📖 About the Product](#-about-the-product) - [🛠️ Application Stack](#️-application-stack) - [✔️ Prerequisites](#️-prerequisites) - [🚀 Installation](#-installation) + - [📖 Access our Documentation](#-access-our-documentation) - [📷 Screenshots](#-screenshots) - [🤝 Contributing](#-contributing) - [📝 License](#-license) @@ -95,6 +96,15 @@ One usecase to demonstrate the capabilities of our tool is the Fibonacci Go Appl --- +## 📖 Access our Documentation + +- 3 ways + - via backstage in the osc + - via file structure in forgejo + - via local backstage in local kind cluster (link to install guide in git repo(seperate file)) + +--- + ## 📷 Screenshots [IMAGES] @@ -115,4 +125,4 @@ Contributions are welcome! 🎉 ## 📝 License -[LICENSE] \ No newline at end of file +[LICENSE] diff --git a/docs/userguide/argocd b/docs/userguide/argocd new file mode 100644 index 0000000..4010539 --- /dev/null +++ b/docs/userguide/argocd @@ -0,0 +1,2 @@ +quick paragraph about argocd +just the specifics what we maybe do differently \ No newline at end of file diff --git a/docs/userguide/ci-workflow.md b/docs/userguide/ci-workflow.md index 0e55e27..d73f0d6 100644 --- a/docs/userguide/ci-workflow.md +++ b/docs/userguide/ci-workflow.md @@ -1,4 +1,4 @@ -# Continuous Integration (CI) Workflow 🚀 +# Continuous Integration (CI) Workflow 🚀 - Franz Our repository includes a **Continuous Integration (CI) workflow** that runs automatically whenever changes are pushed to the codebase. By leveraging Forgejo and GitHub Actions, we ensure that every update is thoroughly validated, resulting in a reliable and error-free image being delivered to the Forgejo registry. diff --git a/docs/userguide/crossplane.md b/docs/userguide/crossplane.md new file mode 100644 index 0000000..b0960a8 --- /dev/null +++ b/docs/userguide/crossplane.md @@ -0,0 +1 @@ +robert \ No newline at end of file diff --git a/docs/userguide/edfBuilder.md b/docs/userguide/edfBuilder.md index e69de29..7ee6210 100644 --- a/docs/userguide/edfBuilder.md +++ b/docs/userguide/edfBuilder.md @@ -0,0 +1,7 @@ +robert +What does the edfBuilder do? + +Whats the structure + +Local install +osc install \ No newline at end of file diff --git a/docs/userguide/forgejo.md b/docs/userguide/forgejo.md new file mode 100644 index 0000000..6f6f68e --- /dev/null +++ b/docs/userguide/forgejo.md @@ -0,0 +1,5 @@ +Franz + +runner setup +forgejo registry +project and issue management of forgejo \ No newline at end of file diff --git a/docs/userguide/grafana.md b/docs/userguide/grafana.md index e69de29..bde8844 100644 --- a/docs/userguide/grafana.md +++ b/docs/userguide/grafana.md @@ -0,0 +1,3 @@ +robert +quick chapter about grafana +loki, prometheus, etc. just mentioned \ No newline at end of file diff --git a/docs/userguide/openbao.md b/docs/userguide/openbao.md index fdca26b..43a92aa 100644 --- a/docs/userguide/openbao.md +++ b/docs/userguide/openbao.md @@ -1,11 +1,13 @@ -# OpenBao +# OpenBao michal ## 📋 Outline -- [What is it?](#what-is-it) -- [Main features](#main-features) -- [Quick start guide](#quick-start-guide) -- [Configuration](#configuration) -- [References](#references) +- [OpenBao michal](#openbao-michal) + - [📋 Outline](#-outline) + - [🧐 What is it?](#-what-is-it) + - [📦 Main features](#-main-features) + - [⏱️ Quick start guide](#️-quick-start-guide) + - [⚙️ Configuration](#️-configuration) + - [🔗 References](#-references) ## 🧐 What is it? diff --git a/docs/userguide/petclinic.md b/docs/userguide/petclinic.md new file mode 100644 index 0000000..caee692 --- /dev/null +++ b/docs/userguide/petclinic.md @@ -0,0 +1 @@ +patrick \ No newline at end of file