The documentation in this folder describes how to develop DPL CMS.
The focus of the documentation is to inform developers of how to develop the CMS, and give some background behind the various architectural choices.
The documentation falls into two categories:
The Markdown-files in this directory document the system as it. Eg. you can read about how to add a new entry to the core configuration.
The ./architecture folder contains our Architectural Decision Records that describes the reasoning behind key architecture decisions. Consult these records if you need background on some part of the CMS, or plan on making any modifications to the architecture.
As for the remaining files and directories
- ./diagrams contains diagram files like draw.io or PlantUML and rendered diagrams in png/svg format. See the section for details.
- ./images this is just plain images used by documentation files.
- ./Taskfile.yml a go-task Taskfile,
run
taskto list available tasks.
We strive to keep the diagrams and illustrations used in the documentation as maintainable as possible. A big part of this is our use of programmatic diagramming via PlantUML and Open Source based manual diagramming via diagrams.net (formerly known as draw.io).
When a change has been made to a *.puml or *.drawio file, you should
re-render the diagrams using the command task render and commit the result.