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

docs(structure): WiP added more ideas for the content structure

Browse source
This commit is contained in:
Stephan Lo 2025-11-12 09:03:10 +01:00
parent 3f1efb1343
commit 44245dbfcc
1 changed files with 16 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

21
content/en/docs/platform-overview.md
View file

@ -1,21 +1,32 @@
--- ---
title: "Platform Documentation Overview" title: "eDF Documentation Overview"
description: "Comprehensive guide for users and auditors to understand and use the platform." description: "Comprehensive guide for users and auditors to understand and use the eDF."
--- ---
# Meta
## Guidelines
1. for users/developers/engineers we describe our output / outcome as product
* it is usable
* there are links / lists to repos
2. we have and describe a 'product-structure-tree'
3. for auditors we have a list / cross reference to Jira tickets
# Introduction # Introduction
- Purpose of the platform - Purpose of the eDF
- Target audience (developers, engineers, auditors) - Target audience (developers, engineers, auditors)
- High-level product structure overview
- High-level architecture overview - High-level architecture overview
# Platform Components Overview # eDF Components Overview
- List of all major components - List of all major components
- Vertical and horizontal layers explained - Vertical and horizontal layers explained
- Component maturity/status (fully integrated, partial, experimental) - Component maturity/status (fully integrated, partial, experimental)
# Getting Started # Getting Started
- Quickstart guide for developers - Quickstart guide for developers
- Onboarding steps for platform engineers - Onboarding steps for eDF engineers
- Prerequisites and environment setup - Prerequisites and environment setup
# Component Details # Component Details