This is a template for the OSLO publication environment.
Version 3 has been replaced with version 4. The latest version of 3 is 3.1.3. As version 3 is depending on not maintained software, i.e. the maintenance has been shifted to new core software corresponding version 4, users relying on toolchain 4 are requested to upgrade their setup.
Release 4 is therefore a breaking change from the software perspective. From the data specification editor perspective this release has no impact on the way of working. The underlying software is, though, more strict and therefore existing data specifications that are processable by version 3 might require an update. In most cases these are editorial mistakes, or issues resulting from the editorial process in the UML editor. Editors should consult https://github.com/Informatievlaanderen/OSLO-UML-Transformer/wiki for common issues and how to resolve them.
Release 4 also comes with an improved monitoring and statistcs. This allows to followup more precisely the quality of the data standards.
The version of this template is found in config/config.json.
This template forms the boilerplate for the publication environment. The repository OSLOthema-template is a boilerplate template for the OSLOthema repositories.
The objective of an instance of this template is to automate the publication of the data specifications in a static website. The data specification are managed in separate thema repositories. Separating the data specifications content from the publication environment creates flexibility and scaling potential, without losing a central control. The content of the static website is available in the generated repository. The operational deployment the static website is indepedent from, and beyond the configuration of this repository. A possible setup is described in a separate chapter.
After the template has initiated a publication environment, the setup has to be completed with additional configuration.
- Create the corresponding generated repository. A plain empty repository is sufficient
- Read the configuration instructions in
- Follow the instructions and adapt and setup the configurations for one hostname (e.g. for the development hostname)
- adapt thus the configuration files to your context
- activate CircleCI processing
- Select a demo thema repository containing a valid data specification for testing purposes, and configure the first publication point.
- address any technical error, until the demo publication point is successfully processed and resulted in an expected commit in the generated repository.
- remove any boilerplate documentation files that is superflusious.
- Create a new branch with the new version number. By preference starting from the branch with the previous version number.
- Bump the version number in the Changelog and config/config.json
- Make your changes
Releasing and merging into the main branch are to be discussed.