DevFW-CICD/website-and-documentation
23
0
Fork 1
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
website-and-documentation/content/en/_index.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

2.6 KiB
Raw Blame History

title
IPCEI-CIS Developer Framework

{{< blocks/cover title="IPCEI-CIS Developer Framework" image_anchor="top" height="full" >}}

A comprehensive enterprise development platform enabling teams to build, deploy, and operate cloud-native applications with ease.

{{< blocks/link-down color="info" >}} {{< /blocks/cover >}}

{{% blocks/lead color="primary" %}} The IPCEI-CIS Developer Framework provides everything you need to deliver modern applications at scale. Built on open standards and battle-tested technologies. {{% /blocks/lead %}}

{{% blocks/section color="dark" type="row" %}}

{{% blocks/feature icon="fa-solid fa-diagram-project" title="Architecture Documentation" url="/docs/architecture/" %}} Explore the platform's architecture with interactive C4 diagrams. Understand the system design, components, and deployment topology.

Dive into the architecture → {{% /blocks/feature %}}

{{% blocks/feature icon="fa-solid fa-book-open" title="Technical Writer Guide" url="/docs/documentation/" %}} Learn how to contribute to this documentation. Write content, test locally, and understand the CI/CD pipeline.

Start documenting → {{% /blocks/feature %}}

{{% blocks/feature icon="fa-solid fa-archive" title="Legacy Documentation (v1)" url="/docs/v1/" %}} Access the previous version of our documentation including historical project information and early architecture decisions.

Browse v1 docs → {{% /blocks/feature %}}

{{% /blocks/section %}}

{{% blocks/section color="white" %}}

What's in the Platform?

🚀 Developer Experience

  • Backstage Portal - Self-service platform
  • GitOps Workflows - Automated deployments
  • Golden Paths - Best practices built-in

🛠️ Infrastructure as Code

  • Crossplane - Cloud resource provisioning
  • ArgoCD - Declarative GitOps
  • Terraform - Infrastructure automation

📊 Observability

  • Prometheus & Grafana - Metrics & dashboards
  • Loki - Log aggregation
  • OpenTelemetry - Distributed tracing

{{% /blocks/section %}}

{{% blocks/section color="light" %}}

Get Started

Whether you're a platform engineer, application developer, or technicalWriter, we have resources for you:

{{% /blocks/section %}}