Skip to content

Add GitLab Docs as part of DevOps: Create, Group: SSE

Marcia Ramos requested to merge docs-added-to-categories-create into master

Proposal

We should create a new, non-marketing category for GitLab Documentation Site, maintained by the Static Site Editor group.

Background

The GitLab Technical Writers need help maintaining the Docs project. Historically, they have not had any dedicated engineering resources and relied on the goodwill contributions of GitLab team members to execute on their backlog. An open position that had been slated for a dedicated engineer has been deferred for the foreseeable future. This leaves the Docs project with little support for an increasingly technically-demanding project.

Justification

  1. Technical writers are one of the primary personas for the Static Site Editor. Working closely with the Docs project will help inform the feature direction and provide opportunities to dogfood the feature.
  2. One of the new Front End Engineers on the Static Site Editor group (Jacques Erasmus) has worked extensively on the Docs project.
  3. The Static Site Editor group is already beginning to work with the Algolia Docs team to evaluate Frontman, a new, more performant static site generator that has potential to replace Middleman in the next few months. Our Docs project make use of Algolia's search features.
  4. The structure of the Docs project closely mirrors that of the Handbook, in that it's outside of the GitLab.org project and uses a static site generator.
  5. Strategic objective to have the GitLab Docs project dogfood the Static Site Editor functionality.

Approvals

Merge requests with changes to stages and groups and significant changes to categories need to be created, approved, and/or merged by each of the below:

The following people need to be on the merge request so they stay informed:

  • EVP of Engineering @edjdev
  • Senior Director of Development @clefelhocz1
  • Director of Quality @meks
  • The Product Marketing Manager relevant to the stage group(s) @jordi_mon
Edited by Sid Sijbrandij

Merge request reports