Technical writing with Continuous Integration and docs-as-code
The post reflects a creative “book tasting party” at a school library, inspiring thoughts of a similar event for documentation sites. It highlights different static site generators—Sphinx, Astro, Hugo, Jekyll, MkDocs, and Docusaurus—each compared to a beverage, emphasizing their unique features, strengths, and suitability for documentation projects.
In open source, all sorts of interesting connections happen. In open source documentation, an even more narrowly defined group of folks connect the dots for others. Recently I was interviewed by Mirantis, an OpenStack services startup, about my involvement with OpenStack documentation. They’re doing a series of interviews with the technical leads in OpenStack. We […]
An article I wrote on GitHub for the docslikecode.com website: What if you could use GitHub, static site generators, and Continuous Integration and Deployment (CI/CD) for our documentation? I imagine you can track your backlog and get some metrics on the quality with their nice contributor graphs. I bet you could measure “docs drift” to […]