Articles

What is CI/CD development? How does CI/CD relate to docs-as-code? How can I write and maintain human-readable documentation while incorporating an automated testing framework to my review process? We provide an infographic and a description that illustrates our take on how CI/CD documentation, DocOps, and the Docs-as-code integrate.

In this article, we outline the basic principles of Docs-as-Code, some tools for writing and running automated tests against your documentation, and how these workflows can help improve the quality of your documentation. Using VS Code, git workflows, and automated documentation quality tests with Vale, we’ll show you how these tools can be used in concert in your DocOps setup.

In the first part of our new Docs As Code series, you will read about the philosophy behind the approach coupled with Quality Assurance, and how you can get started.

On the Write The Docs London meetup in January speakers from leading Git code repositories talked about how their teams dogfood their own tools to do their documentation. _Version the Docs_ covered Bitbucket and GitLab, but we missed a GitHub presentation. To fill this gap, we interviewed Anne Gentle about GitHub, treating docs like code, and community contributions to documentation.

Twilio is regarded as one of the API industry’s leaders, so when, after five years, Twilio changes the documentation format on their developer portal, everybody wants to know why. Jarod Reyes and Andrew Baker (both developers of Twilio's developer education team) gave a presentation about the reason for the changes at SIGNAL 2016. Because we found them valuable and wanted to share them with our developer portal mailinglist, we’ll summarize their findings in this blog post.