Proof of concept to edit the GitLab handbook with netlifycms (or other open source alternative)

This issue was closed after a successful dive into the Netlifycms project and an attempt to integrate into our handbook. The recorded review can be found here: https://youtu.be/4tnHeBf_etE

Problem to solve

Netlifycms is an open source static site editor. It's possible we could integrate this into GitLab for a great static site editing experience. At this point in time, it's unclear if this solution would work with our handbook or how it would integrate into GitLab.

Proposal

Create a proof of concept outside of the GitLab application that allows netlifycms to make changes to the GitLab handbook. Ideally, this issue would close upon the successful ability to edit the handbook using netlifycms. It's also possible this issue closes without us reaching that goal, but fully understanding the barriers or challenges in the way of this happening.

Things to achieve

  • Modify handbook pages using netlifycms
  • View changes side by side as they are being made
  • Create new pages
  • Easily link pages
  • Open MR on publish to maintain approval workflows through MR approvals

Desired Workflow

Questions to answer

  • Does our handbook need to be rearchitected in order to be edited by netlifycms (or another open source static site editor)?
Edited Nov 18, 2019 by Eric Brinkman
Assignee Loading
Time tracking Loading