Skip to content

Comments on Wiki Pages

Problem

GitLab for Knowledge Management features two prominent solutions, GitLab Pages and GitLab Wiki. GitLab Wiki allows users to create Pages detailing specific projects, order them in a tree, see version history, and manually link these Pages to Issues/Epics/MRs/etc. However, it is very challenging to have conversations around the content of a Page. Users report having to manually link an Issue to a Page, the linked Issue being where conversations around the Page happen. These types of workflows decrease productivity and disconnect users from the very context they need to effectively move forward on a project.

Solution

Comments should be available in GitLab Wiki Pages for better usability of Wiki Pages. Comments provide an avenue for effective discussion, questions, and collaboration, and ultimately allow projects to move forward more efficiently.

There are several areas in which we can enable comments:

1: At the bottom of a Wiki pages (similar to what an activity thread looks like today on an Issue or Epic object type).

2: Adjacent to a specific line of text by highlighting it. A user could highlight and add a comment similar to how we are able to do so on lines of code today.

Requirements

  1. Top-level discussions
    • Goal: Allow people to be able to add comments at the bottom of a Wiki page. Each comment can also have a thread of follow-up replies. This should work similar to how comments on issues work today.
  2. Contextual discussions
    • Goal: Allow people to be able to select and quote some text on the page and start a discussion. The comment can similarly have replies as well. This should work similar to how comments on merge request diffs work today.
  3. Suggesting changes
    • Goal: Allow people to edit a document in "suggest mode", where any content that is added is marked green, and any content that is deleted is marked red. These changes show up as highlighted content with comments as well with options to either "Accept" or "Decline" the suggestion.

Competitor Solutions to Problem

This page may contain information related to upcoming products, features and functionality. It is important to note that the information presented is for informational purposes only, so please do not rely on the information for purchasing or planning purposes. Just like with all projects, the items mentioned on the page are subject to change or delay, and the development, release, and timing of any products, features, or functionality remain at the sole discretion of GitLab Inc.

This page may contain information related to upcoming products, features and functionality. It is important to note that the information presented is for informational purposes only, so please do not rely on the information for purchasing or planning purposes. Just like with all projects, the items mentioned on the page are subject to change or delay, and the development, release, and timing of any products, features, or functionality remain at the sole discretion of GitLab Inc.

This page may contain information related to upcoming products, features and functionality. It is important to note that the information presented is for informational purposes only, so please do not rely on the information for purchasing or planning purposes. Just like with all projects, the items mentioned on the page are subject to change or delay, and the development, release, and timing of any products, features, or functionality remain at the sole discretion of GitLab Inc.

Edited by 🤖 GitLab Bot 🤖