refactor: remove old README.md and index.md files, update mkdocs.yaml navigation
This commit is contained in:
parent
2f8eac5452
commit
6c9d026c16
4 changed files with 2 additions and 60 deletions
|
@ -1,4 +0,0 @@
|
||||||
# Getting Started
|
|
||||||
|
|
||||||
Main entry point
|
|
||||||
|
|
|
@ -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]
|
|
1
docs/index.md
Symbolic link
1
docs/index.md
Symbolic link
|
@ -0,0 +1 @@
|
||||||
|
../README.md
|
|
@ -2,7 +2,7 @@ site_name: EDPDoc
|
||||||
site_description: 'EDP documentation'
|
site_description: 'EDP documentation'
|
||||||
|
|
||||||
nav:
|
nav:
|
||||||
- Home: '../README.md'
|
- Home: 'README.md'
|
||||||
- Overview:
|
- Overview:
|
||||||
- User Documentation: 'gettingstarted/user-documentation.md'
|
- User Documentation: 'gettingstarted/user-documentation.md'
|
||||||
- User Guide:
|
- User Guide:
|
||||||
|
|
Loading…
Reference in a new issue