diff --git a/README.md b/README.md index 7c4cf54..f4c8675 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,34 @@ # eDF Release 'PoC' [WiP] +This is a preliminary README just sketching the structure of work - when we reach the 'PoC' milestone it will be replaces by an main documentation entry point for our customers who want to consume the 'edf_poc' product. + ## POC Content Structure -This is the PoC content structure (see top right topics 1-3): ![](image.png) +* [Part 1 - User documentation](https://jira.telekom-mms.com/browse/IPCEICIS-368) +* Part 2 - Hands On + * [Part 2.1 - Local IdP creation](https://jira.telekom-mms.com/browse/IPCEICIS-765) + * [Part 2.2 - OSC IdP creation](https://jira.telekom-mms.com/browse/IPCEICIS-766) + * Part 2.1 & 2.2 Use Cases + * [Part 2.x.1 - Golden Path template for a Go application](https://jira.telekom-mms.com/browse/IPCEICIS-514) + * [Part 2.x.2 - Fibonacci Go application](https://jira.telekom-mms.com/browse/IPCEICIS-759) + * [Part 2.x.3 - Forgejo Actions with respect to the Fibonacci CI/CD](https://jira.telekom-mms.com/browse/IPCEICIS-760) + * [Part 2.x.4 - Telemetry with respect to the Fibonacci workload](https://jira.telekom-mms.com/browse/IPCEICIS-761) + * [Part 2.x.5 - OSC infrastructure with respect to the Fibonacci workload](https://jira.telekom-mms.com/browse/IPCEICIS-762) + * [Part 2.x.6 - Additional bells and whistles](https://jira.telekom-mms.com/browse/IPCEICIS-763) + * [Part 2.3 - Extended Local IdP creation and orchestration](https://jira.telekom-mms.com/browse/IPCEICIS-767) + * Part 2.3 Use Cases + * tbd +* [Part 3 - User documentation](https://jira.telekom-mms.com/browse/IPCEICIS-768) + + +## Content and Story + +This is the Storybook of the PoC content structure (content is depicted top right): + +![](./content-and-storybook.png) ## Use case content of 2.1 and 2.2 'Hands On' -This is the use case content: ![](image-1.png)contents \ No newline at end of file +This is the illustration of the [use cases (aka 'functionality') in the PoC content](https://confluence.telekom-mms.com/display/IPCEICIS/Proof+of+Concept+2024): + +![](./use-cases.png) \ No newline at end of file diff --git a/image.png b/content-and-storybook.png similarity index 100% rename from image.png rename to content-and-storybook.png diff --git a/image-1.png b/use-cases.png similarity index 100% rename from image-1.png rename to use-cases.png