Speaker
Michele Mesiti
(Karlsruhe Institute of Technology (KIT))
Description
Maintaining documentation up to date can be difficult.
Synchronization between the behaviour of the software and the documentation is, on the other hand, extremely important. Lack of it means that users might lose trust in the maintainers (this is even more important for the documentation of a HPC system), and its presence is crucial, for example, for Tutorial-Driven-Development, where the documentation acts as an integration test suite for the code.
In this talk I will present a view of the challenges associated with the problem, look at solutions that the community has adopted, and present the solution developed for our specific use case and discuss how CI can support this practice.
Primary author
Michele Mesiti
(Karlsruhe Institute of Technology (KIT))
