2.3 KiB
eDF Release 'PoC' [WiP]
This is a preliminary README in 'WiP' state - it's just sketching the story and structure of work.
When we reach the 'PoC' milestone it will be replaced by a short and concise README as the main documentation entry point for our customers who want to consume the 'edf_poc' product.
POC Content Structure
- Part 1 - User documentation
- Part 2 - Hands On
- Part 2.1 - Local IdP creation
- Part 2.2 - OSC IdP creation
- Part 2.1 & 2.2 Use Cases
- Part 2.x.1 - Golden Path template for a Go application
- Part 2.x.2 - Fibonacci Go application
- Part 2.x.3 - Forgejo Actions with respect to the Fibonacci CI/CD
- Part 2.x.4 - Telemetry with respect to the Fibonacci workload
- Part 2.x.5 - OSC infrastructure with respect to the Fibonacci workload
- Part 2.x.6 - Additional bells and whistles
- Part 2.3 - Extended Local IdP creation and orchestration
- Part 2.3 Use Cases
- tbd
- Part 3 - User documentation
Content and Story
This is the Storybook of the PoC content structure (content is depicted top right):
Use case content of 2.1 and 2.2 'Hands On'
This is the illustration of the use cases (aka 'functionality') in the PoC content:
Technical composition
The 'edf_poc'-product should be as self-contained as possible.
Thus all parts coming from upstream repos should have a physical copy in this repo with a reference to the upstream repo. Therefore we need a mapping table from parts here to references in upstreams.
Alternative: Submodules
Proposal: The final product will be a export of the repo