Gitlab hero border pattern left svg Gitlab hero border pattern right svg

Category Direction - Wiki

Wiki

   
Stage Create
Maturity Viable
Content Last Reviewed 2020-12-30

Introduction and how you can help

Thanks for visiting the Wiki category direction page in GitLab. This page belongs to the Editor group of the Create stage and is maintained by Eric Schurter (E-Mail).

This strategy is a work in progress, and everyone can contribute to it:

Overview

GitLab Wikis are a great way to share documentation and organize information via built-in functionality. Each GitLab project includes a Wiki rendered by Gollum, and backed by a Git repository.

Walkthrough of GitLab wikis (starts at 9 minutes):

Where we are Headed

Shipping in 13.5, we've added Group Level Wikis which will give our organizations the ability to collaborate in a shared wiki that spans multiple projects. (This is currently the most upvoted issue on GitLab!) In the future, we will be tackling issues around Markdown rendering, improving support for other formats, and tidying up navigation in the Wiki.

We are beginning to explore a Confluence integration and testing Confluence Cloud with our own projects. Work on this can be seen in this epic.

As we look to future plans beyond 2020, we will be exploring ways to implement real time editing and WYSIWYG collaboration. We know that our backend of Git will support WYSIWG, but we may need a new architecture for live editing. Ideally, we want to solve the problem of collaborative note taking, be highly approachable for everyone, but also offer the tremendous benefits of storing the content in a portable plain text format that can be cloned, viewed and edited locally (properties of Git).

As our current wiki is built on top of Git, there may be a need for a more streamlined editing experience that is not backed by Git. We may call this GitLab Notes.

Target Audience and Experience

What's Next & Why

We are currently working on:

After we complete the work on Group Wiki, we'll be focused on:

What is Not Planned Right Now

In October 2020 the Wiki category was moved into the Editor group. Among other benefits, this realignment of categories means the Wiki has the same DRI as the Web IDE, Snippets, and Static Site Editor and one of the immediate goals for the Editor group is implementing a new rich text, WYSIWYG editor. The intent of this new editor is to allow other categories to adopt the same component for a consistent experience. While the implementation of this WYSIWYG editor is not our primary focus for the Wiki, it's likely that we will be able to benefit from the new editor with relatively little effort. Given its usage and similar target persona, the Wiki would be a great secondary dogfooding opportunity for the new rich text editor.

In other words, while we're not actively working on WYSIWYG or collaborative, real-time editing for the Wiki, other categories have similar needs and the work being done on these features may be valuable to the Wiki in the near future.

Maturity Plan

This category is currently at the Viable maturity level, and our next maturity target is 2021 (see our definitions of maturity levels).

Competitive Landscape

We currently most closely compete with GitHub Wikis but we would like to compete with:

Top Customer Success/Sales issue(s)

Top user issue(s)

Top dogfooding issues

GitLab does not have any organization-wide wikis, but some teams do use them for various purposes.

Top Strategy Item(s)

Git is a trademark of Software Freedom Conservancy and our use of 'GitLab' is under license