Create initial architecture documentation for backend

informatik-heilbronn / transparenz-cockpit

Forschungsprojekt Komunale Digitalisierungsplattform

MIT License

2 stars 0 forks source link

Create initial architecture documentation for backend #16

Closed aheil closed 2 years ago

aheil commented 2 years ago

For a quick ramp-up of new project members and contributrs, we should provide a sustainable documentation of the backend architecture.

As proposed a C4 model on level 3 would be suitable.

[x] Include C4 PlantUML as code in the repository (https://github.com/plantuml-stdlib/C4-PlantUML)
[x] Optional: Set up a pipeline that created C4 diagrams after a checkin/change of the diagram source files

Faroesne commented 2 years ago

First C4 PlantUML created and pushed in c851526 . The puml file can be found in the newly created documentation folder. Next step is set up the pipeline for creating C4 diagrams.

Faroesne commented 2 years ago

Pipeline for generating svg files was created and finished with 3e6b8f4