Stephan Lo
62999b41d0
- 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
2 KiB
| title | weight | description |
|---|---|---|
| Use Cases | 2 | The golden paths in the engineers and product development domain |
Rationale
The challenge of IPCEI-CIS Developer Framework is to provide value for DTAG customers, and more specifically: for Developers of DTAG customers.
That's why we need verifications - or test use cases - for the Developer Framework to develop.
(source: https://tag-app-delivery.cncf.io/whitepapers/platforms/)
Golden Paths as Use Cases
- https://platformengineering.org/blog/how-to-pave-golden-paths-that-actually-go-somewhere
- https://thenewstack.io/using-an-internal-developer-portal-for-golden-paths/
- https://nl.devoteam.com/expert-view/building-golden-paths-with-internal-developer-platforms/
- https://www.redhat.com/en/blog/designing-golden-paths
List of Use Cases
Here we have a collection of possible usage scenarios.
Socksshop
Deploy and develop the famous socks shops:
-
See also mkdev fork: https://github.com/mkdev-me/microservices-demo
Humanitec Demos
Github Examples
Telemetry Use Case with respect to the Fibonacci workload
The Fibonacci App on the cluster can be accessed on the path https://cnoe.localtest.me/fibonacci. It can be called for example by using the URL https://cnoe.localtest.me/fibonacci?number=5000000.
The resulting ressource spike can be observed one the Grafana dashboard "Kubernetes / Compute Resources / Cluster". The resulting visualization should look similar like this:
When and how to use the developer framework?
e.g. an example
.... taken from https://cloud.google.com/blog/products/application-development/common-myths-about-platform-engineering?hl=en
