Skip to content

Migrate GitLab Handbook from Middleman to Frontman

Problem to solve

TODO: This issue should be combined with or replace the Middleman epic, and have individual sub-issues created for the tasks identified below).

Middleman is the static site generator that powers all of about.gitlab.com, including the GitLab Handbook. At the scale we have achieved, we are running into numerous issue related to performance and collaboration. Frontman is a project started by Algolia in response to the exact problems we face.

Algolia's team has granted us alpha access to Frontman and we should evaluate the feasibility of implementing it as a drop-in replacement for Middleman.

Approach

  • NOTE: We will not be converting the marketing site in the monorepo as part of this conversion. We will only convert the handbook site. The marketing website team is currently evaluating their tech stack needs and will establish which SSG they will use still.
  1. Convert existing custom Middleman extensions to helper methods
  2. Add monorepo support to Frontman
  3. Complete decouple the handbook from the marketing site, by not sharing any assets NOTE: We will attempt to do the conversion without having a complete decoupling as a prerequisite.
  4. Migrate the Handbook site from Middleman to Frontman

Identified Prerequisites and Tasks

Testing and Acceptance Criteria

  • Dev and build modes works for handbook and marketing sites
  • All stylesheets work for handbook and marketing sites
  • All javascripts work for handbook and marketing sites
Edited by Chad Woolley