edp-doc/docs/gettingstarted/user-documentation.md

User Documentation

📋 Outline

• What is it? (short description what the software does, max 3 sentences)
  • A couple of use cases (different scopes)
  • Why do I need / want this? When should I pass?
  • Compare with other platforms
  • Compare with well-known tools (what parts of my stack / pipeline does this cover?)
    • argo -> vercel
    • monitoring -> data dog
    • forgejo -> graphite
• Main features (brief list of main features and enablers - why it is in the stack)
  • what are our opinions / core principles and believes that are backed in?
    • k8s > *
  • Developer Portal: Backstage
• Quick start guide
• Configuration
  • structure of the poc (where / how can I change something?)
  • how does it work? (bootstrapping++)
• Known Issues / TODOs
• References (documentation links etc...)

🧐 What is it?

📦 Main features

⏱️ Quick start guide

⚙️ Configuration

🔗 References

• Technical Documentation