Documenation Standardization
The following projects and sub projects should have an standardized readme:
- Common Services
- Libraries
- OCM W-Stack
- PCM Cloud
- PCM App
- Dev Ops
Readme Template:
- Introduction (What is it, and whats the purpose)
- Flow
- Dependencies (e.g. Matrix)
- Bootstrap (How to start and which prerequistes) --> Docker Compose?
- Deployment (Settings, Helm Usage) --> Description how to use the Helm Chart
- Developer Information (how to use the API, details about information) Swagger File (similiar to https://gitlab.eclipse.org/eclipse/xfsc/tsa/signer/-/blob/main/gen/http/openapi3.json) Details
Edited by Steffen Schulze