The Liatrio team has been working on perfecting our DevOps Engineering and DevOps Consulting internship programs since 2016. Starting an internship program from scratch is a territory that brings forth many unforeseen challenges. One of these challenges, documenting an introduction to DevOps, has proven to be a worthwhile deliverable in its own right. You can read more about the origins of the internship program and how Liatrio’s DevOps Bootcamp documentation came about in Building a Successful DevOps Bootcamp for Interns.
When interns are introduced to Liatrio’s DevOps Bootcamp, they are encouraged to improve it whenever they come across an area that is lacking. Some of these improvements might include outdated content, styling, or new sections. The internship program is nearing two years since its origin, and the documentation has reached a point where other people interested in DevOps could definitely benefit from checking it out. We needed to find the best way to deliver this content in a way that would allow the DevOps community to easily contribute if they wanted to, so the decision was made to transition the home of the documentation to GitHub as an open-source project and host it as a website.
I will now briefly explain what technologies we chose to accomplish this transition and why we chose them. If you want to see the finished product first, please check out Liatrio’s DevOps Bootcamp and then come back to read the behind-the-scenes story!
First, a public repository was created on GitHub, liatrio/devops-bootcamp. Then, documentation tools that leveraged a balance between features and simplicity were researched leading to the discovery of docsify. Docsify was the perfect tool for the job because it was widely used on GitHub, supported Markdown, looked clean, was maintainable, and offered plugins that encouraged editing on GitHub.
This required that the entire set of documentation be converted to Markdown. This is obviously a large task. However, it was deemed worthwhile considering the direction the project was headed in. In terms of implementation, docsify was very simple to pick up. The most difficult part was probably creating the sidebar as this is a manual step. Once a few sections of the bootcamp were converted to Markdown and docsify was successfully serving the bootcamp locally, it was time to determine the hosting solution.
Netlify was chosen to host the bootcamp due to its abundance of static-hosting features. Using our liatr.io domain, we configured continuous deployment, auto-renewing Let’s Encrypt certificates, and HTTP to HTTPS redirects. Once all of this was running smoothly, the last step was to create an introduction page that clearly outlined what Liatrio’s DevOps Bootcamp was and its intended audience. We summarized this information on the first page of the bootcamp.
Liatrio’s DevOps Bootcamp is an ongoing project. If you want to contribute, please submit a pull-request, create an issue, or star the repository and check it out later. You can also tweet me @shanemacbride or @liatrio.
Liatrio is a DevOps Consulting firm focussing on helping enterprises get better at software delivery using DevOps & Rapid Release philosophies. We work as “boots on the ground change agents” helping our clients re-imagine their daily work and get better at delivery one day at a time. Liatrio is also hiring! If you enjoy being a part of a team that is solving challenges around software delivery automation, deployment pipelines, and large-scale transformations, reach out to us via our contact page on our website.