Technical guide

Disclaimer: This page contains references to technical concepts, processes and integrations used in the development life-cycle of CI/CD Docs. Please proceed with caution.

Website tech spec

CI/CD Docs is a simple client-side app developed using the basics. SASS is used as a pre-processor for CSS. Mustache.js is used as a template engine making it a single-page application. JavaScript unit tests are done using Jasmine + Chutzpah.

Source control

Code is hosted on GitHub and simple feature branching is followed. The master branch is the single source of truth.

Hosting

The site is hosted on GitHub powered by GitHub Pages. As a result, an extra branch called gh-pages exists from where the site is served.

Azure DevOps

Continuous Integration build runs each time code is checked-in to master, and a new pull request (PR) is created. It builds the solution and runs JavaScript unit tests (having temporary issues).

Netlify

Using Netlify, each time a new PR is created, a new instance of the website is deployed with a staging URL. Netlify adds code to disallow search engines from crawling the site.

Hund.io

A live independently-hosted status page is provided by Hund. This also allows us to create a planned maintenance for the future.

Webtask.io

Using Hund's live status page API endpoint, we're using Webtask.io to create a serverless function and then use Shields.io to create a status badge - one for operational status and the other for uptime %.

Documentation

Gitbook powers this documentation site.