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

Category Direction - Wiki

Wiki

   
Stage Create
Maturity Viable
Content Last Reviewed 2020-09-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!) We will also 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 non-technical users, 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

Ongoing: Group level wiki - Currently wiki's are only on the project level. Next we are moving them to Group level and making them container agnostic so we can expand on this and add them as a Global Wiki.

Currently we are working on:

Ongoing: GitLab Confluence Integration - We've added a way to link any Confluence Wiki to your GitLab project. In the coming quarters we'll be exploring ways to make that integration more useful to our customers.

Next: Improve AsciiDoc, RDoc and reStructuredText - Many of our custmoers rely on specific formats to support their wikis. We should make sure our wiki's suppport these formats so that they can use their Group Level wikis as a company.

After: Simplify wiki editing - Currently wiki editing is inconsistent with every other page, both visually and from a workflow perspective. This makes wiki less approachable for users familiar with the rest of GitLab. We should fix these inconsistencies as a priority.

After: Improve wiki navigation - As wikis grow with more and more content, GitLab is not providing the tools necessary to make them easy to navigate and use. This is a problem that can be resolved with support for macros and a few other small improvements. We're adding a layer of meta data into wiki pages that will help us with search and navigation and exploring how to upgrade wiki search.

Later: Deeper integration of wikis with GitLab Once the immediate useability is addressed by the epics above, next we make sure that Wiki's can embed Issues, Designs or display other objects from GitLab.

What is Not Planned Right Now

Right now, we are not working on WYSIWYG and Live Editing, but instead setting the stage with our architecture and cleaning up the existing experience. We expect to dive into editing features later in 2021. We are watching carefully the SSE Team and their issue on choosing a WYSIWG editor. This could be used for our wiki with the addition of translator plugins for each wiki format.

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:

Analyst Landscape

TBD

Top Customer Success/Sales issue(s)

Top user issue(s)

Top internal customer issue(s)

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