Skip to content

How this site was created

How this site was created

We utilized an open-source tool called MkDocs .

MkDocs is a fast, simple, and downright gorgeous static site generator specifically designed for building project documentation. But it’s not just about documentation—cool things can be done with MkDocs!

As developers, we often find ourselves writing a lot of code and documentation. We decided to leverage MkDocs not only to showcase our work but also to enhance our site's speed by serving it as a static site.

To streamline our development process, we implemented a CI/CD (Continuous Integration/Continuous Deployment) pipeline. This allows us to deploy our updates directly to GitHub, ensuring that our site is always up-to-date with the latest changes.

Join us on this journey as we explore the limitless possibilities of MkDocs!

CI/CD

What is CI/CD?

CI/CD stands for Continuous Integration and Continuous Deployment. It is a set of practices and principles that aim to improve software development and deployment processes.

Continuous Integration (CI)
  • Automated Testing: Developers frequently integrate code changes into a shared repository, where automated tests run to verify the new code's functionality and ensure it doesn't break existing features.
  • Early Detection of Issues: By integrating code often, teams can catch and fix bugs early in the development process, reducing the cost and complexity of resolving issues later on.
  • Continuous Deployment (CD)
  • Automated Deployment: Once code changes pass automated tests, they are automatically deployed to production environments. This means that updates can reach users quickly and reliably.
  • Faster Time to Market: With CD, new features, bug fixes, and improvements can be delivered to users more frequently, keeping the software relevant and improving user satisfaction.
Our CI/CD Process
  • Edit Locally: I edit the page on my local machine.
  • Push to github: I push the changes to github.
  • Docker Provisioning: GitLab provisions a Docker image on our server that contains everything we need.
  • Build with MkDocs: The site is built using MkDocs within that Docker image. Upload the Result: The final build is uploaded to my hosting provider.
  • Clean Up: The Docker container is then removed to free up resources.

This automated process ensures that our site remains consistent and up-to-date, allowing us to focus on what we do best—developing and documenting!

Contact us to ask how a ci/cd pipeline will replace old bad practices used in development so far