Patrick.Sy/website-and-documentation
1
0
Fork 0
forked from DevFW-CICD/website-and-documentation
Code Pull requests Activity
website-and-documentation/content/en/docs-old/v1/project/conceptual-onboarding/storyline.md
Stephan Lo 62999b41d0 feat(docs): restructure documentation with new framework and templates 
- Archive old docs to docs-old/ for reference
- Create new top-down documentation structure:
  * Platform Overview: purpose, audience, product structure
  * Components: individual platform components (Forgejo, Kubernetes, Backstage)
  * Getting Started: onboarding and quick start guides
  * Operations: deployment, monitoring, troubleshooting
  * Governance: ADRs, project history, compliance
- Add DOCUMENTATION-GUIDE.md with writing guidelines and templates
- Add component template (TEMPLATE.md) for consistent documentation
- Simplify root README and move technical docs to doc/ folder
- Update test configuration:
  * Exclude legacy content from markdown linting
  * Relax HTML validation for theme-generated content
  * Skip link checking for legacy content in test:links
  * Keep 'task test' clean for technical writers (100% pass)
  * Add 'task test:full' with comprehensive link checking
- Update home page with corrected markdown syntax
- Fix internal links in archived content

BREAKING CHANGE: Documentation structure changed from flat to hierarchical top-down approach
2025-11-16 13:32:10 +01:00

1.1 KiB
Raw Blame History

Storyline

  1. We have the 'Developer Framework'
  2. We think the solution for DF is 'Platforming' (Digital Platforms)
    1. The next evolution after DevOps
    2. Gartner predicts 80% of SWE companies to have platforms in 2026
    3. Platforms have a history since roundabout 2019
    4. CNCF has a working group which created capabilities and a maturity model
  3. Platforms evolve - nowadys there are Platform Orchestrators
    1. Humanitec set up a Reference Architecture
    2. There is this 'Orchestrator' thing - declaratively describe, customize and change platforms!
  4. Mapping our assumptions to solutions
    1. CNOE is a hot candidate to help and fulfill our platform building
    2. CNOE aims to embrace change and customization!
  5. Showtime CNOE

Challenges

  1. Don't miss to further investigate and truely understand DF needs
  2. Don't miss to further investigate and truely understand Platform capabilities
  3. Don't miss to further investigate and truely understand Platform orchestration
  4. Don't miss to further investigate and truely understand CNOE solution

Architecture