Patrick.Sy/website-and-documentation
1
0
Fork 0
forked from DevFW-CICD/website-and-documentation
Code Pull requests Activity

docs(getting-started): remove draft 'Getting Started' guide for Edge Developer Platform, reworked Getting Started on chapter page

Browse source
This commit is contained in:
Stephan Lo 2025-12-19 13:41:03 +01:00
parent d106cc2b11
commit 977e9d7e8a
2 changed files with 15 additions and 72 deletions
Download patch file Download diff file Expand all files Collapse all files

17
content/en/docs/edp/_index.md
View file

@ -16,6 +16,7 @@ The magenta **EDP** represents the developer platform: a shared, productized lay
In this modern DevOps setup, EDP acts as the hub: it synchronizes with local development and **deploys applications to target clouds** (for example, an EdgeConnect cloud), while providing the operational capabilities needed to run them safely. Agentic AI can support both loops—for example by assisting developers with implementation and testing in the inner loop, and by automating reviews, policy checks, release notes, and deployment verification (including drift detection and remediation) in the outer loop.
## Product Structure
EDP consists of multiple integrated components organized in layers:
@ -24,16 +25,28 @@ EDP consists of multiple integrated components organized in layers:
The foundation layer provides essential platform capabilities including source code management, CI/CD, and container orchestration.
For documentation, see: [Basic Platform Concepts](./deployment/basics/) and [Forgejo](./forgejo/)
### Developer Experience
Tools and services that developers interact with directly to build, test, and deploy applications.
For documentation, see: [Forgejo](./forgejo/) and [Deployment](./deployment/)
### Infrastructure & Operations
Infrastructure automation, observability, and operational tooling for platform management.
For documentation, see: [Operations](./operations/) and [Infrastructure as Code](./deployment/infrastructure/)
## Getting Started
For quick start guides and onboarding information, see the [Getting Started](../getting-started/) section.
EDP is available at https://edp.buildth.ing.
For detailed component information, explore the [Components](../components/) section.
EDP includes a Forgejo instance that hosts both public and private repositories containing all EDP components.
To request access and get onboarded, start with the welcome repository:
- https://edp.buildth.ing/edp-team/welcome
Once you have access to the repositories, you can explore the EDP documentation according to the product structure above.

70
content/en/docs/edp/getting-started.md
View file

@ -1,70 +0,0 @@
---
title: "Getting Started"
linkTitle: "Getting Started"
weight: 1
description: >
Quick start guides and onboarding information for the Edge Developer Platform.
---
{{% alert title="Draft" color="warning" %}}
**Editorial Status**: This page is currently being developed.
* **Jira Ticket**: TBD
* **Assignee**: Team
* **Status**: Draft - Structure only
* **Last Updated**: 2025-11-16
* **TODO**:
* [ ] Add concrete quick start steps
* [ ] Include prerequisites and access information
* [ ] Create first application tutorial
{{% /alert %}}
## Welcome to EDP
This section helps you get started with the Edge Developer Platform, whether you're a developer building applications or a platform engineer managing infrastructure.
## Quick Start for Developers
### Prerequisites
* Access to EDP instance
* Git client installed
* kubectl configured (for Kubernetes access)
* Basic knowledge of containers and CI/CD
### Your First Application
1. **Access the Platform**: Log in to Backstage portal
2. **Clone Repository**: Get your application repository from Forgejo/GitLab
3. **Configure Pipeline**: Set up CI/CD in Woodpecker or ArgoCD
4. **Deploy**: Push code and watch automated deployment
### Next Steps
* Explore available components and services
* Review platform documentation and best practices
* Join the developer community
## Quick Start for Platform Engineers
### Platform Access
* Kubernetes cluster access
* Infrastructure management tools
* Monitoring and observability dashboards
### Key Resources
* Platform architecture documentation
* Operational runbooks
* Troubleshooting guides
## Documentation Template
When creating "Getting Started" content for a component:
1. **Prerequisites**: What users need before starting
2. **Step-by-Step Guide**: Clear, numbered instructions
3. **Verification**: How to confirm success
4. **Common Issues**: FAQ and troubleshooting
5. **Next Steps**: Links to deeper documentation