Visual review of MkDocs sites in GitLab MRs
This is a repost of my original article in Siemens' blog with some formatting enhancements.
Leveraging GitLab CI job artifacts and GitLab review apps enables easy visual review of MkDocs sites in merge requests with a great developer experience and no extra infrastructure.
Advanced editorial workflows involving collaborative writing, content review, and approval are first-class citizens to Docs as Code (DaC), which is the philosophy of creating documentation – and more generally, static websites – by using the same tools and workflows that are commonly used to develop code. Instead of requiring specialized content management systems, DaC uses plain-text markup, a VCS and a DevOps platform. This enables review through merge requests (MRs), and validation and deployment to a static site hosting service through CI/CD.