CESSDA Platform - Taking a new approach: #1 Technical Documentation As Code
Here is the first in a series of articles about how the Platform team is improving the quality and availability of CESSDA's Technical Infrastructure.
CESSDA provides a Platform as a Service (PaaS) for its members to deploy software applications on to. This comes with a set of common code management, build, test and deployment tools and processes that developers use to reduce the friction that would otherwise arise when code is developed in one environment and deployed and maintained elsewhere.
CESSDA is continually improving its PaaS processes and toolchains, and has recently adopted three new approaches, intended to: improve the quality and availability of relevant technical documentation; simplify the deployment of microservices to managed clusters; eliminate the gap between what should be deployed and what is actually deployed.
This article looks at how the CESSDA Platform team goes about improving the quality and availability of relevant technical documentation: firstly by touching on the background relating to the theory and practice of ‘documentation as code’; secondly by looking in detail at CESSDA’s implementation.
It is the first in a series of articles. The next one will be ‘#2 Deploying microservices with Helm’, which will take a similar approach to this one.
Read the full article by our CESSDA Cloud Platform Delivery Director and Technical Working Group Leader John Shepherdson on LinkedIn.