Skip to content

Docs: Issue reporting button should include page URL and source context

The Problem

When users click the "Report issue" link on GitLab documentation pages, the created issue lacks important context such as:

  • The URL of the documentation page where the issue was reported
  • The source file path of the documentation
  • The specific text or section that needs attention

Current State

Right now, when someone reports a documentation issue (like a missing screenshot), the resulting GitLab issue is created without any contextual information about where the problem was found. This makes it difficult for maintainers to:

  • Locate the problematic documentation
  • Understand what specific content needs fixing
  • Efficiently address the reported issue

The Request

The issue is asking to enhance the documentation "Report issue" functionality to automatically include:

  1. Page context - URL of the doc page where the issue was reported
  2. Source information - Path to the documentation source file
  3. Specific content reference - The particular text or section that needs attention

Impact

This would improve the documentation maintenance workflow by providing maintainers with immediate context, reducing the back-and-forth needed to understand and resolve documentation issues.

Edited by 🤖 GitLab Bot 🤖